DoneJS StealJS jQuery++ FuncUnit DocumentJS
3.14.1
5.0.0 4.3.0 2.3.35
  • About
  • Guides
  • API Docs
  • Community
  • Contributing
  • Bitovi
    • Bitovi.com
    • Blog
    • Design
    • Development
    • Training
    • Open Source
    • About
    • Contact Us
  • About
  • Guides
  • API Docs
    • Observables
      • can-compute
      • can-define
      • can-define/list/list
      • can-define/map/map
      • can-define-stream
      • can-define-stream-kefir
      • can-event
      • can-event/async/async
      • can-event/batch/batch
      • can-event/lifecycle/lifecycle
      • can-kefir
      • can-list
      • can-map
      • can-map-backup
      • can-map-define
      • can-observation
      • can-observe
      • can-simple-map
      • can-simple-observable
      • can-stream
      • can-stream-kefir
    • Data Modeling
      • can-connect
      • can-connect-cloneable
      • can-connect-feathers
      • can-connect-ndjson
      • can-connect-signalr
      • can-fixture
      • can-fixture-socket
      • can-ndjson-stream
      • can-set
    • Views
      • can-component
      • can-ejs
      • can-element
      • can-react-component
      • can-stache
      • can-stache/helpers/route
      • can-stache-bindings
      • can-stache-converters
      • can-view-autorender
      • can-view-callbacks
      • can-view-href
      • can-view-import
      • can-view-live
      • can-view-model
      • can-view-nodelist
      • can-view-parser
      • can-view-scope
      • can-view-target
      • react-view-model
      • react-view-model/component
      • steal-stache
    • Routing
      • can-deparam
      • can-param
      • can-route
      • can-route-pushstate
    • JS Utilities
      • can-assign
      • can-define-lazy-value
      • can-globals
      • can-key-tree
      • can-make-map
      • can-parse-uri
      • can-string
      • can-string-to-any
      • can-util
      • can-zone
      • can-zone-storage
    • DOM Utilities
      • can-ajax
      • can-attribute-encoder
      • can-control
      • can-dom-events
      • can-event-dom-enter
      • can-event-dom-radiochange
      • can-jquery
    • Data Validation
      • can-define-validate-validatejs
      • can-validate
      • can-validate-interface
      • can-validate-legacy
      • can-validate-validatejs
    • Typed Data
      • can-cid
      • can-construct
      • can-construct-super
      • can-namespace
      • can-reflect
      • can-reflect-promise
      • can-types
    • Polyfills
      • can-symbol
      • can-vdom
    • Core
    • Infrastructure
      • can-global
      • can-test-helpers
        • ./dev
          • devOnlyTest
          • willError
          • willWarn
    • Ecosystem
    • Legacy
  • Community
  • Contributing
  • GitHub
  • Twitter
  • Chat
  • Forum
  • News
Bitovi

willWarn

  • Edit on GitHub

Requests that [can-log/dev/dev.warn canDev.warn] track and notify about matching warnings.

dev.willWarn(expected, [fn])

Parameters

  1. expected {String|Regexp}:

    The warning message to check for

  2. fn {function(String, Boolean)}:

    an optional callback to fire on every warning; each call has the actual warning message and a Boolean indicating whether it was matched

Returns

{function}:

A function that tears down the warning check and returns the number of matched warnings when called.

willWarn() takes either a String or a RegExp as its expected warning, and does a full, case-sensitive String match in the case of a String, or a regex test in the case of a RegExp, for every warning logged through [can-log/dev/dev.warn]. In addition, if fn is provided, it is fired on every warning with the content of the warning message and whether it matched expected.

willWarn() returns a teardown function, which must be called at least once to disable the tracking of the matched warning. when called, the teardown function returns the number of times expected was matched by a dev warning.

var dev = require('can-log/dev/dev');
var devHelpers = require('can-test-helpers/lib/dev');

var finishWarningCheck = devHelpers.willWarn("something evil", function(message, match) {
     message; // -> "something evil"
     match; // true
});

canDev.warn("something evil");

finishWarningCheck(); // -> 1

CanJS is part of DoneJS. Created and maintained by the core DoneJS team and Bitovi. Currently 3.14.1.

On this page

Get help

  • Chat with us
  • File an issue
  • Ask questions
  • Read latest news