Chai Documentation

Guides

• Accessing Utilities
• Adding Language Chains
• Adding Methods
• Adding Properties
• Assertion Styles
• Basic Assertion
• Building a Helper
• Composing Error Messages
• Composing an Assertion
• Core Plugin Concepts
• Methods as Properties
• Overwriting Language Chains
• Overwriting Methods
• Overwriting Properties
• Plugin Utilities
• Using Flags
• flag usage
• object flag

Methods

• assert.approximately
• assert.assert
• assert.changes
• assert.changesButNotBy
• assert.changesBy
• assert.closeTo
• assert.containsAllDeepKeys
• assert.containsAllKeys
• assert.decreases
• assert.decreasesButNotBy
• assert.decreasesBy
• assert.deepEqual
• assert.deepInclude
• assert.deepNestedInclude
• assert.deepNestedPropertyVal
• assert.deepOwnInclude
• assert.deepPropertyVal
• assert.doesNotChange
• assert.doesNotDecrease
• assert.doesNotDecreaseBy
• assert.doesNotHaveAllDeepKeys
• assert.doesNotHaveAllKeys
• assert.doesNotHaveAnyDeepKeys
• assert.doesNotHaveAnyKeys
• assert.doesNotIncrease
• assert.doesNotThrow
• assert.equal
• assert.exists
• assert.fail
• assert.hasAllDeepKeys
• assert.hasAllKeys
• assert.hasAnyDeepKeys
• assert.hasAnyKeys
• assert.ifError
• assert.include
• assert.includeDeepMembers
• assert.includeDeepOrderedMembers
• assert.includeMembers
• assert.includeOrderedMembers
• assert.increases
• assert.increasesButNotBy
• assert.increasesBy
• assert.instanceOf
• assert.isAbove
• assert.isArray
• assert.isAtLeast
• assert.isAtMost
• assert.isBelow
• assert.isBoolean
• assert.isDefined
• assert.isEmpty
• assert.isExtensible
• assert.isFalse
• assert.isFinite
• assert.isFrozen
• assert.isFunction
• assert.isNaN
• assert.isNotArray
• assert.isNotBoolean
• assert.isNotEmpty
• assert.isNotExtensible
• assert.isNotFalse
• assert.isNotFrozen
• assert.isNotFunction
• assert.isNotNaN
• assert.isNotNull
• assert.isNotNumber
• assert.isNotObject
• assert.isNotOk
• assert.isNotSealed
• assert.isNotString
• assert.isNotTrue
• assert.isNull
• assert.isNumber
• assert.isObject
• assert.isOk
• assert.isSealed
• assert.isString
• assert.isTrue
• assert.isUndefined
• assert.lengthOf
• assert.match
• assert.nestedInclude
• assert.nestedProperty
• assert.nestedPropertyVal
• assert.notDeepEqual
• assert.notDeepInclude
• assert.notDeepNestedInclude
• assert.notDeepNestedPropertyVal
• assert.notDeepOwnInclude
• assert.notDeepPropertyVal
• assert.notEqual
• assert.notExists
• assert.notInclude
• assert.notIncludeDeepMembers
• assert.notIncludeDeepOrderedMembers
• assert.notIncludeMembers
• assert.notIncludeOrderedMembers
• assert.notInstanceOf
• assert.notMatch
• assert.notNestedInclude
• assert.notNestedProperty
• assert.notNestedPropertyVal
• assert.notOwnInclude
• assert.notProperty
• assert.notPropertyVal
• assert.notSameDeepMembers
• assert.notSameDeepOrderedMembers
• assert.notSameMembers
• assert.notSameOrderedMembers
• assert.notStrictEqual
• assert.notTypeOf
• assert.oneOf
• assert.operator
• assert.ownInclude
• assert.property
• assert.propertyVal
• assert.sameDeepMembers
• assert.sameDeepOrderedMembers
• assert.sameMembers
• assert.sameOrderedMembers
• assert.strictEqual
• assert.throws
• assert.typeOf
• config.includeStack
• config.showDiff
• config.truncateThreshold
• expect.NaN
• expect.a
• expect.above
• expect.all
• expect.any
• expect.arguments
• expect.below
• expect.by
• expect.change
• expect.closeTo
• expect.decrease
• expect.deep
• expect.empty
• expect.eql
• expect.equal
• expect.exist
• expect.extensible
• expect.fail
• expect.false
• expect.finite
• expect.frozen
• expect.include
• expect.increase
• expect.instanceof
• expect.itself
• expect.keys
• expect.least
• expect.lengthOf
• expect.match
• expect.members
• expect.most
• expect.nested
• expect.not
• expect.null
• expect.ok
• expect.oneOf
• expect.ordered
• expect.own
• expect.ownPropertyDescriptor
• expect.property
• expect.respondTo
• expect.satisfy
• expect.sealed
• expect.string
• expect.throw
• expect.true
• expect.undefined
• expect.within
• utils.addChainableMethod
• utils.addLengthGuard
• utils.addMethod
• utils.addProperty
• utils.compareByInspect
• utils.compatibleConstructor
• utils.compatibleInstance
• utils.compatibleMessage
• utils.expectTypes
• utils.flag
• utils.getActual
• utils.getConstructorName
• utils.getFuncName
• utils.getMessage
• utils.getOperator
• utils.getOwnEnumerableProperties
• utils.getOwnEnumerablePropertySymbols
• utils.getPathInfo
• utils.getPathValue
• utils.getProperties
• utils.hasProperty
• utils.inspect
• utils.isProxyEnabled
• utils.objDisplay
• utils.overwriteChainableMethod
• utils.overwriteMethod
• utils.overwriteProperty
• utils.proxify
• utils.test
• utils.transferFlags

Styles

• assert
• expect