Function is

is(u: unknown): boolean
is
Type-guard from unknown to Seed.

The is function is also an object whose properties narrow to a particular member or subset of members of Seed.
Parameters
- u: unknown
Returns boolean
- Defined in packages/schema-seed/src/seed.ts:659

Index

Properties

associative bigint integer nullary number positional special string unary

Methods

any array boolean eq intersect never null object optional record symbol tuple undefined union unknown void

Properties

associative

associative: <T>(u: unknown) => u is Associative<T>

bigint

bigint: t.has<[0], t_of<(u: unknown) => u is "@traversable/schema/URI::bigint">>

integer

integer: t.has<
[0],
t_of<(u: unknown) => u is "@traversable/schema/URI::integer">,
>

nullary

number

number: t.has<[0], t_of<(u: unknown) => u is "@traversable/schema/URI::number">>

positional

positional: <T>(u: unknown) => u is Positional<T>

special

special: <T>(u: unknown) => u is SpecialCase<T>

string

string: t.has<[0], t_of<(u: unknown) => u is "@traversable/schema/URI::string">>

unary

unary: <T>(u: unknown) => u is Seed.Unary<T>

Methods

any

any(u: unknown): u is "@traversable/schema/URI::any"
Parameters
- u: unknown
Returns u is "@traversable/schema/URI::any"
- Defined in packages/schema-seed/src/seed.ts:667

array

array<T>(u: unknown): u is [tag: "@traversable/schema/URI::array", T]
Type Parameters
- T
Parameters
- u: unknown
Returns u is [tag: "@traversable/schema/URI::array", T]
- Defined in packages/schema-seed/src/seed.ts:679

boolean

boolean(u: unknown): u is "@traversable/schema/URI::boolean"
Parameters
- u: unknown
Returns u is "@traversable/schema/URI::boolean"
- Defined in packages/schema-seed/src/seed.ts:672

eq

eq<T>(u: unknown): u is [tag: "@traversable/schema/URI::eq", def: T]
Type Parameters
- T
Parameters
- u: unknown
Returns u is [tag: "@traversable/schema/URI::eq", def: T]
- Defined in packages/schema-seed/src/seed.ts:678

intersect

intersect<T>(
u: unknown,
): u is [tag: "@traversable/schema/URI::intersect", readonly T[]]
Type Parameters
- T
Parameters
- u: unknown
Returns u is [tag: "@traversable/schema/URI::intersect", readonly T[]]
- Defined in packages/schema-seed/src/seed.ts:683

never

never(u: unknown): u is "@traversable/schema/URI::never"
Parameters
- u: unknown
Returns u is "@traversable/schema/URI::never"
- Defined in packages/schema-seed/src/seed.ts:666

null

null(u: unknown): u is "@traversable/schema/URI::null"
Parameters
- u: unknown
Returns u is "@traversable/schema/URI::null"
- Defined in packages/schema-seed/src/seed.ts:670

object

object<T>(
u: unknown,
): u is [tag: "@traversable/schema/URI::tuple", { [x: string]: T }]
Type Parameters
- T
Parameters
- u: unknown
Returns u is [tag: "@traversable/schema/URI::tuple", { [x: string]: T }]
- Defined in packages/schema-seed/src/seed.ts:685

optional

optional<T>(u: unknown): u is [tag: "@traversable/schema/URI::optional", T]
Type Parameters
- T
Parameters
- u: unknown
Returns u is [tag: "@traversable/schema/URI::optional", T]
- Defined in packages/schema-seed/src/seed.ts:680

record

record<T>(u: unknown): u is [tag: "@traversable/schema/URI::record", T]
Type Parameters
- T
Parameters
- u: unknown
Returns u is [tag: "@traversable/schema/URI::record", T]
- Defined in packages/schema-seed/src/seed.ts:681

symbol

symbol(u: unknown): u is "@traversable/schema/URI::symbol"
Parameters
- u: unknown
Returns u is "@traversable/schema/URI::symbol"
- Defined in packages/schema-seed/src/seed.ts:673

tuple

tuple<T>(u: unknown): u is [tag: "@traversable/schema/URI::tuple", readonly T[]]
Type Parameters
- T
Parameters
- u: unknown
Returns u is [tag: "@traversable/schema/URI::tuple", readonly T[]]
- Defined in packages/schema-seed/src/seed.ts:684

undefined

undefined(u: unknown): u is "@traversable/schema/URI::undefined"
Parameters
- u: unknown
Returns u is "@traversable/schema/URI::undefined"
- Defined in packages/schema-seed/src/seed.ts:671

union

union<T>(u: unknown): u is [tag: "@traversable/schema/URI::union", readonly T[]]
Type Parameters
- T
Parameters
- u: unknown
Returns u is [tag: "@traversable/schema/URI::union", readonly T[]]
- Defined in packages/schema-seed/src/seed.ts:682

unknown

unknown(u: unknown): u is "@traversable/schema/URI::unknown"
Parameters
- u: unknown
Returns u is "@traversable/schema/URI::unknown"
- Defined in packages/schema-seed/src/seed.ts:668

void

void(u: unknown): u is "@traversable/schema/URI::void"
Parameters
- u: unknown
Returns u is "@traversable/schema/URI::void"
- Defined in packages/schema-seed/src/seed.ts:669

Function is

is

Parameters

Returns boolean

Index

Properties

Methods

Properties

associative

bigint

integer

nullary

number

positional

special

string

unary

Methods

any

Parameters

Returns u is "@traversable/schema/URI::any"

array

Type Parameters

Parameters

Returns u is [tag: "@traversable/schema/URI::array", T]

boolean

Parameters

Returns u is "@traversable/schema/URI::boolean"

eq

Type Parameters

Parameters

Returns u is [tag: "@traversable/schema/URI::eq", def: T]

intersect

Type Parameters

Parameters

Returns u is [tag: "@traversable/schema/URI::intersect", readonly T[]]

never

Parameters

Returns u is "@traversable/schema/URI::never"

null

Parameters

Returns u is "@traversable/schema/URI::null"

object

Type Parameters

Parameters

Returns u is [tag: "@traversable/schema/URI::tuple", { [x: string]: T }]

optional

Type Parameters

Parameters

Returns u is [tag: "@traversable/schema/URI::optional", T]

record

Type Parameters

Parameters

Returns u is [tag: "@traversable/schema/URI::record", T]

symbol

Parameters

Returns u is "@traversable/schema/URI::symbol"

tuple

Type Parameters

Parameters

Returns u is [tag: "@traversable/schema/URI::tuple", readonly T[]]

undefined

Parameters

Returns u is "@traversable/schema/URI::undefined"

union

Type Parameters

Parameters

Returns u is [tag: "@traversable/schema/URI::union", readonly T[]]

unknown

Parameters

Returns u is "@traversable/schema/URI::unknown"

void

Parameters

Returns u is "@traversable/schema/URI::void"

Settings

On This Page

`is`