Interface IKeysOp<R>

This interface provides methods for filtering keys within an assertion scope.

interface IKeysOp<R> {
    keys: KeysFn<R>;
    (...keys: string[]): R;
    (keys: Object | readonly any[], evalMsg?: MsgSource): R;
}

Type Parameters

R
The type of the result of the operation.

Hierarchy (View Summary)

KeysFn<R>
- IKeysOp
  - IAllOp
  - IAnyOp

IKeysOp(...keys: string[]): R
Asserts that the current value has the given keys.
Parameters
- ...keys: string[]
  The keys to retrieve.
Returns R
The result of the operation, which will generally be the existing IAssertScope.that object.
- Defined in assert/interface/ops/IKeysOp.ts:15
IKeysOp(keys: Object | readonly any[], evalMsg?: MsgSource): R
Asserts that the current value has the given keys.
Parameters
- keys: Object | readonly any[]
  A single array of keys or an object containing the expected keys to assert.
- OptionalevalMsg: MsgSource
  The optional evaluation message.
Returns R
The result of the operation, which will generally be the existing IAssertScope.that object.
- Defined in assert/interface/ops/IKeysOp.ts:15

Index

Properties

Properties

keys

keys: KeysFn<R>

Provides access to filters that operate on the keys of the current IScopeContext value within the assertion scope.

Param: keys

The keys to filter.

Returns

The result of the operation