Prism | @zwolf/prism

Type parameters

T = any

Hierarchy

Prism

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Prism<T>(value: undefined | T, path?: Path, warnings?: Warning[]): Prism<T>

- Defined in prism.ts:11
Type parameters
- T = any
Parameters
- value: undefined | T
- path: Path = []
- warnings: Warning[] = []
Returns Prism<T>

Properties

Readonly exists

exists: boolean

Readonly path

path: Path

Readonly value

value: undefined | T

Readonly warnings

warnings: Warning[]

Methods

get

get<C>(key: PathKey, options?: { quiet?: boolean }): Prism<C>

- Defined in prism.ts:34
Type parameters
- C = any
Parameters
- key: PathKey
- options: { quiet?: boolean } = {}
  - Optional quiet?: boolean
Returns Prism<C>

has

has(key: PathKey): boolean

- Defined in prism.ts:65
Parameters
- key: PathKey
Returns boolean

toArray

toArray(): Prism<T[keyof T]>[]

- Defined in prism.ts:69
Returns Prism<T[keyof T]>[]

transform

transform<C>(fn: (prism: Prism<T>) => C): Prism<C>

- Defined in prism.ts:22
Type parameters
- C = unknown
Parameters
- fn: (prism: Prism<T>) => C
  - - (prism: Prism<T>): C
    - Parameters
      - prism: Prism<T>
      Returns C
Returns Prism<C>

warn

warn(error: Error, path?: Path): void

- Defined in prism.ts:83
Parameters
- error: Error
- path: Path = []
Returns void

Generated using TypeDoc