Skip to main content Link Search Menu Expand Document (external link)

CommandDirective.ts overview

Since v1.0.0


Exports Grouped by Category


constructors

builtIn

Signature

declare const builtIn: (option: BuiltInOptions) => CommandDirective<never>

Source

Since v1.0.0

userDefined

Signature

declare const userDefined: <A>(leftover: ReadonlyArray<string>, value: A) => CommandDirective<A>

Source

Since v1.0.0

mapping

map

Signature

declare const map: {
  <A, B>(f: (a: A) => B): (self: CommandDirective<A>) => CommandDirective<B>
  <A, B>(self: CommandDirective<A>, f: (a: A) => B): CommandDirective<B>
}

Source

Since v1.0.0

models

BuiltIn (interface)

Signature

export interface BuiltIn {
  readonly _tag: "BuiltIn"
  readonly option: BuiltInOptions
}

Source

Since v1.0.0

CommandDirective (type alias)

Signature

type CommandDirective<A> = BuiltIn | UserDefined<A>

Source

Since v1.0.0

UserDefined (interface)

Signature

export interface UserDefined<A> {
  readonly _tag: "UserDefined"
  readonly leftover: ReadonlyArray<string>
  readonly value: A
}

Source

Since v1.0.0

refinements

isBuiltIn

Signature

declare const isBuiltIn: <A>(self: CommandDirective<A>) => self is BuiltIn

Source

Since v1.0.0

isUserDefined

Signature

declare const isUserDefined: <A>(self: CommandDirective<A>) => self is UserDefined<A>

Source

Since v1.0.0