Parseus | @rijudev/parseus

Encoder class

Type parameters

T

Hierarchy

Parseus

Index

Constructors

constructor

Properties

model
parser

Methods

Constructors

constructor

new Parseus(model: IParameterlessConstructor<T>, parser?: ParseFunction): Parseus

- Defined in repository/repository.ts:44
Parameters
- model: IParameterlessConstructor<T>
- Optional parser: ParseFunction
Returns Parseus

Properties

Private model

model: IParameterlessConstructor<T>

Private Optional parser

parser: ParseFunction

Methods

decode

decode(json: object): T

- Defined in repository/repository.ts:53
Returns a decoded model instance with their fields populated

Parameters
- json: object
Returns T

model instance

encode

encode(obj: T): object

- Defined in repository/repository.ts:62
Returns an encoded object

Parameters
- obj: T
Returns object
- [key: string]: any

Static decode

decode(json: object): Decoder

- Defined in repository/repository.ts:23
Returns a decoder instance ready to decode into a Model

Parameters
- json: object
Returns Decoder

Static encode

encode<T>(obj: T, model?: IParameterlessConstructor<T>): object

- Defined in repository/repository.ts:32
Returns an encoded object

Type parameters
- T
Parameters
- obj: T
- Optional model: IParameterlessConstructor<T>
Returns object
- [key: string]: any

Static parseOverrride

parseOverrride<T>(parser: ParseFunction, model: IParameterlessConstructor<T>): Parseus<T>

- Defined in repository/repository.ts:42
Returns a enconde instance with custom parser types declarations ready to encode into an new object

Type parameters
- T
Parameters
- parser: ParseFunction
- model: IParameterlessConstructor<T>
Returns Parseus<T>

Generated using TypeDoc