predicat - v1.1.2

Index

Type aliases

Predicate

Functions

Type aliases

Predicate

Predicate<T>: (param: T) => boolean

Type parameters

T

Type declaration

- (param: T): boolean
- A statement that may be true or false depending on the values of its variable.
  
  Parameters
  - param: T
    
    (optional if T is void) The predicate's parameter
  Returns boolean
  A boolean result, making a statement about the given parameter.

Functions

Const allOf

allOf<T>(...predicates: (boolean | Predicate<T>)[]): Predicate<T>

- Defined in factory-predicates.ts:15
Alias for every. See every.

Type parameters
- T
Parameters
- Rest ...predicates: (boolean | Predicate<T>)[]
Returns Predicate<T>

Const always

always(param: void): boolean

- Defined in simple-predicates.ts:7
A predicate that always verifies.

Parameters
- param: void
Returns boolean
true.

every

every<T>(...predicates: (boolean | Predicate<T>)[]): Predicate<T>

- Defined in factory-predicates.ts:8
Combine predicates, verifying only if they all do.

Type parameters
- T
Parameters
- Rest ...predicates: (boolean | Predicate<T>)[]
Returns Predicate<T>
true if all given predicates also do, false otherwise.

isArray

isArray(subject: unknown): subject is any[]

- Defined in type-guards.ts:35
Check if the subject is an Array (can be used as a type guard).

Parameters
- subject: unknown
  
  the variable to check.
Returns subject is any[]
true the given parameter is an Array, false otherwise.

isBoolean

isBoolean(subject: unknown): subject is boolean

- Defined in type-guards.ts:7
Check if the subject is a boolean (can be used as a type guard).
Will return false if the subject is a Boolean object.

Parameters
- subject: unknown
  
  the variable to check.
Returns subject is boolean
true the given parameter is a boolean, false otherwise.

Const isFalse

isFalse(param: any): boolean

- Defined in simple-predicates.ts:60
A predicate that verifies if the subject is false.
Will return false if the subject is new Boolean(false).

Parameters
- param: any
Returns boolean
true the subject is false, false otherwise.

Const isFalsy

isFalsy(param: any): boolean

- Defined in simple-predicates.ts:39
A predicate that verifies if the subject is falsy.
Will return false if the subject is new Boolean(false).

Parameters
- param: any
Returns boolean
true the subject is falsy, false otherwise.

isMap

isMap(subject: unknown): subject is Map<any, any>

- Defined in type-guards.ts:53
Check if the subject is a Map (can be used as a type guard).

Parameters
- subject: unknown
  
  the variable to check.
Returns subject is Map<any, any>
true the given parameter is a Map, false otherwise.

isNill

isNill(subject: unknown): boolean

- Defined in type-guards.ts:89
Check if the subject is undefined or null.

Parameters
- subject: unknown
  
  the variable to check.
Returns boolean
true the given parameter is undefined or null, false otherwise.

isNull

isNull(subject: unknown): subject is null

- Defined in type-guards.ts:80
Check if the subject is null (can be used as a type guard).

Parameters
- subject: unknown
  
  the variable to check.
Returns subject is null
true the given parameter is null, false otherwise.

isNumber

isNumber(subject: unknown): subject is number

- Defined in type-guards.ts:26
Check if the subject is a number (can be used as a type guard).
Will return true if the subject is NaN.

Parameters
- subject: unknown
  
  the variable to check.
Returns subject is number
true the given parameter is a number, false otherwise.

isRegExp

isRegExp(subject: unknown): subject is RegExp

- Defined in type-guards.ts:62
Check if the subject is a RegExp (can be used as a type guard).

Parameters
- subject: unknown
  
  the variable to check.
Returns subject is RegExp
true the given parameter is a RegExp, false otherwise.

isSet

isSet(subject: unknown): subject is Set<any>

- Defined in type-guards.ts:44
Check if the subject is a Set (can be used as a type guard).

Parameters
- subject: unknown
  
  the variable to check.
Returns subject is Set<any>
true the given parameter is a Set, false otherwise.

isString

isString(subject: unknown): subject is string

- Defined in type-guards.ts:16
Check if the subject is a string (can be used as a type guard).

Parameters
- subject: unknown
  
  the variable to check.
Returns subject is string
true the given parameter is a string, false otherwise.

Const isTrue

isTrue(param: any): boolean

- Defined in simple-predicates.ts:52
A predicate that verifies if the subject is true.
Will return false if the subject is new Boolean(true).

Parameters
- param: any
Returns boolean
true the subject is true, false otherwise.

Const isTruthy

isTruthy(param: any): boolean

- Defined in simple-predicates.ts:31
A predicate that verifies if the subject is truthy.
Will return true if the subject is new Boolean(false).

Parameters
- param: any
Returns boolean
true the subject is truthy, false otherwise.

isUndefined

isUndefined(subject: unknown): subject is undefined

- Defined in type-guards.ts:71
Check if the subject is undefined (can be used as a type guard).

Parameters
- subject: unknown
  
  the variable to check.
Returns subject is undefined
true the given parameter is undefined, false otherwise.

Const never

never(param: void): boolean

- Defined in simple-predicates.ts:18
A predicate that never verifies.

Parameters
- param: void
Returns boolean
false.

Const nok

nok(param: void): boolean

- Defined in simple-predicates.ts:23
Alias for never. See never.

Parameters
- param: void
Returns boolean

Const not

not(param: any): boolean

- Defined in simple-predicates.ts:44
Alias for isFalsy. See isFalsy.

Parameters
- param: any
Returns boolean

Const ok

ok(param: void): boolean

- Defined in simple-predicates.ts:12
Alias for always. See always.

Parameters
- param: void
Returns boolean

Const oneOf

oneOf<T>(...predicates: (boolean | Predicate<T>)[]): Predicate<T>

- Defined in factory-predicates.ts:28
Alias for some. See some.

Type parameters
- T
Parameters
- Rest ...predicates: (boolean | Predicate<T>)[]
Returns Predicate<T>

some

some<T>(...predicates: (boolean | Predicate<T>)[]): Predicate<T>

- Defined in factory-predicates.ts:21
Combine predicates, verifying if one or more do.

Type parameters
- T
Parameters
- Rest ...predicates: (boolean | Predicate<T>)[]
Returns Predicate<T>
true if one or more given predicates also do, false otherwise.

Generated using TypeDoc