Class InternString

Hierarchy

Argument
- InternString

Implements

IArgumentComponent<unknown>

Index

Properties

Methods

Properties

api

api: ComponentAPI

name

name: string = "string"

Optional options

options: ArgumentOptions

parent

parent: Entity = ArgumentManager

Methods

error

error(parameter: string, message: string): ArgumentResult<unknown>
error(parameter: string, type: string, message: string): ArgumentResult<unknown>

Inherited from Argument.error
- Defined in src/lib/arguments/Argument.ts:32
Parameters
- parameter: string
- message: string
Returns ArgumentResult<unknown>
Inherited from Argument.error
- Defined in src/lib/arguments/Argument.ts:34
Parameters
- parameter: string
- type: string
- message: string
Returns ArgumentResult<unknown>

ok

ok(value: unknown): ArgumentResult<unknown>

Inherited from Argument.ok
- Defined in src/lib/arguments/Argument.ts:28
Parameters
- value: unknown
Returns ArgumentResult<unknown>

run

run(arg: string): Awaited<Result<unknown, UserError>>

Overrides Argument.run
- Defined in src/lib/arguments/builtin/String.ts:7
Parameters
- arg: string
Returns Awaited<Result<unknown, UserError>>

Generated using TypeDoc