Class Model

constructor

• new Model(type, id): Model

• Parameters

  • type: string

    The type of the model.
  • id: undefined | string

    The id of the model.

  Returns Model

id

links

meta

type

removeRelationship

• removeRelationship(...this, type, id, relationshipName): void

• Removes a relationship from a model.

  Parameters

  • Rest ...this: any
  • type: string

    The type of the dependent model.
  • id: string

    The id of the dependent model.
  • relationshipName: string

    The name of the relationship.

  Returns void

serialize

• serialize(...this, options): JSONAPIDocument

• Serialize a model.

  Parameters

  • Rest ...this: any
  • options: undefined | ModelSerializeOptions

    The options for serialization.

  Returns JSONAPIDocument

  JSON API compliant object.

setAttribute

• setAttribute(...this, attributeName, value): void

• Set/add an attribute to a model.

  Parameters

  • Rest ...this: any
  • attributeName: string

    The name of the attribute.
  • value: any

    The value of the attribute.

  Returns void

setRelationship

• setRelationship(...this, relationshipName, models): void

• Set/add a relationships to a model.

  Parameters

  • Rest ...this: any
  • relationshipName: string

    The name of the relationship.
  • models: null | Model | Model[]

    The linked model(s).

  Returns void

sync

• sync(...this, record, modelFactory): void

• Sync record data to model.

  Parameters

  • Rest ...this: any
  • record: Optional<ResourceObject, "id" | "type">

    Record data to sync.
  • modelFactory: undefined | ((resource) => null | Model)

    Model factory.

  Returns void