@zwolf/prism | @zwolf/prism

PRISM

A library for safely parsing 3rd party API data

API Documentation

You can find the generated docs at https://stayradiated.github.io/prism

Why would I use this?

-

Why would I not use this?

Examples

License

Prism is licensed under the MIT License.

Index

References

default

Classes

Prism

Interfaces

Warning

Type aliases

Functions

References

default

Renames and exports Prism

Type aliases

Path

Path: PathKey[]

PathKey

PathKey: string | number

Transformer

Transformer<C, T>: (prism: Prism<T>) => C

Type parameters

C
T

Type declaration

- (prism: Prism<T>): C
- Parameters
  - prism: Prism<T>
  Returns C

Functions

Const asValue

asValue<C, T>(fn: (value: undefined | T) => C): Transformer<C, T>

- Defined in transformers.ts:5
Type parameters
- C
- T
Parameters
- fn: (value: undefined | T) => C
  - - (value: undefined | T): C
    - Parameters
      - value: undefined | T
      Returns C
Returns Transformer<C, T>

Const defaultTo

defaultTo<V>(defaultValue: V): Transformer<V, V>

- Defined in transformers.ts:10
Type parameters
- V
Parameters
- defaultValue: V
Returns Transformer<V, V>

Const printWarnings

printWarnings(warnings: Warning[], root?: string): void

- Defined in print-warnings.ts:50
Parameters
- warnings: Warning[]
- root: string = 'root'
Returns void

Generated using TypeDoc