Normalizer | jsonapi-typescript

Hierarchy

Normalizer

Index

Constructors

constructor

Properties

cache

Methods

Constructors

constructor

new Normalizer(cache: object): Normalizer

- Defined in src/jsonApiNormalizer.ts:5
Parameters
- cache: object
Returns Normalizer

Properties

cache

cache: any

Methods

idToRecordKey

idToRecordKey(id: string | number | undefined, type: string): string

- Defined in src/jsonApiNormalizer.ts:10
Parameters
- id: string | number | undefined
- type: string
Returns string

parse

parse(__namedParameters: object): any

- Defined in src/jsonApiNormalizer.ts:45
Parameters
- __namedParameters: object
  - data: object
    - data: ResourceObject<string, object> | ResourceObject<string, object>[]
    - included: undefined | ResourceObject<string, object>[]
Returns any

parseErrors

parseErrors(__namedParameters: object): any

- Defined in src/jsonApiNormalizer.ts:56
Parameters
- __namedParameters: object
  - response: object
    - data: object
      - errors: ErrorObject[]
Returns any

parseRelationships

parseRelationships(rel: JSONAPI.RelationshipObject): undefined | string | string[]

- Defined in src/jsonApiNormalizer.ts:19
Parameters
- rel: JSONAPI.RelationshipObject
Returns undefined | string | string[]

parseResObject

parseResObject(__namedParameters: object): any

- Defined in src/jsonApiNormalizer.ts:32
Parameters
- __namedParameters: object
  - attributes: undefined | object
  - id: undefined | string
  - relationships: undefined | RelationshipsObject
  - type: string
Returns any

recordKeyToData

recordKeyToData(key: string): ResourceObject

- Defined in src/jsonApiNormalizer.ts:14
Parameters
- key: string
Returns ResourceObject

toJsonApi

toJsonApi(record?: any): any

- Defined in src/jsonApiNormalizer.ts:64
Parameters
- Default value record: any = {}
Returns any

Generated using TypeDoc