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

CommandDirective overview

Added in v1.0.0


Table of contents


constructors

builtIn

Signature

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

Added in v1.0.0

userDefined

Signature

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

Added in v1.0.0

mapping

map

Signature

export 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>
}

Added in v1.0.0

models

BuiltIn (interface)

Signature

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

Added in v1.0.0

CommandDirective (type alias)

Signature

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

Added in v1.0.0

UserDefined (interface)

Signature

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

Added in v1.0.0

refinements

isBuiltIn

Signature

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

Added in v1.0.0

isUserDefined

Signature

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

Added in v1.0.0