"string" | @quenk/preconditions

Index

Variables

lower
upper

Functions

Variables

Const lower

lower: (value: A) => Result<A, B> = lowercase

Type declaration

- (value: A): Result<A, B>
- Parameters
  - value: A
  Returns Result<A, B>

Const upper

upper: (value: A) => Result<A, B> = uppercase

Type declaration

- (value: A): Result<A, B>
- Parameters
  - value: A
  Returns Result<A, B>

Functions

Const isString

isString<A>(a: A): Either<Failure<A>, string>

- Defined in string.ts:78
isString tests if a value is a string.

Type parameters
- A
Parameters
- a: A
Returns Either<Failure<A>, string>

Const lowercase

lowercase(value: string): Either<Failure<string>, string>

- Defined in string.ts:50
lowercase transforms a string into lowercase

Parameters
- value: string
Returns Either<Failure<string>, string>

Const matches

matches(pattern: RegExp): Precondition<string, string>

- Defined in string.ts:7
matches tests if the value satisfies a regular expression.

Parameters
- pattern: RegExp
Returns Precondition<string, string>

Const maxLength

maxLength(target: number): Precondition<string, string>

- Defined in string.ts:15
maxLength test.

Parameters
- target: number
Returns Precondition<string, string>

Const minLength

minLength(target: number): Precondition<string, string>

- Defined in string.ts:23
minLength test.

Parameters
- target: number
Returns Precondition<string, string>

Const notEmpty

notEmpty(value: string): Either<Failure<string>, string>

- Defined in string.ts:70
ne tests whether a string is empty or not.

Parameters
- value: string
Returns Either<Failure<string>, string>

Const range

range(min: number, max: number): Precondition<string, string>

- Defined in string.ts:32
range tests whether the length of string falls within a range.

Parameters
- min: number
- max: number
Returns Precondition<string, string>

Const split

split(token: string): Precondition<string, string[]>

- Defined in string.ts:64
split a string into an array.

Parameters
- token: string
Returns Precondition<string, string[]>

Const toString

toString<A>(a: A): Either<Failure<A>, string>

- Defined in string.ts:85
toString casts a value into a string.

Type parameters
- A
Parameters
- a: A
Returns Either<Failure<A>, string>

Const trim

trim(value: string): Either<Failure<string>, string>

- Defined in string.ts:58
trim the whitespace from a string.

Parameters
- value: string
Returns Either<Failure<string>, string>

Const uppercase

uppercase(value: string): Either<Failure<string>, string>

- Defined in string.ts:42
uppercase transforms a string into uppercase

Parameters
- value: string
Returns Either<Failure<string>, string>

Generated using TypeDoc