Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ExtensionReadme

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

content

content: () => any = ...

Type declaration

    • (): any

    • Generate a function which returns the value of the given attribute.

      Returns any

data

data: ModelData = {}

The resource object from the API.

exists

exists: boolean = false

Whether or not the resource exists on the server.

freshness

freshness: Date = ...

The time at which the model's data was last updated. Watching the value of this property is a fast way to retain/cache a subtree if data hasn't changed.

Protected store

store: Store

The data store that this resource should be persisted to.

Methods

Protected apiEndpoint

  • apiEndpoint(): string

attribute

  • attribute<T>(attribute: string): T

Protected copyData

delete

id

  • id(): undefined | string

pushAttributes

pushData

Protected rawRelationship

save

Static attribute

  • attribute<T>(name: string): () => T
  • attribute<T, O>(name: string, transform: (attr: O) => T): () => T

  • Generate a function which returns the value of the given attribute.

    Type parameters

    • T

    Parameters

    • name: string

    Returns () => T

      • (): T

      • Generate a function which returns the value of the given attribute.

        Returns T

  • Type parameters

    • T

    • O = unknown

    Parameters

    • name: string
    • transform: (attr: O) => T
        • (attr: O): T

        • Parameters

          • attr: O

          Returns T

    Returns () => T

      • (): T

      • Returns T

Static Protected getIdentifier

Static hasMany

  • hasMany<M>(name: string): () => false | (undefined | M)[]

  • Generate a function which returns the value of the given has-many relationship.

    Type parameters

    Parameters

    • name: string

    Returns () => false | (undefined | M)[]

    false if no information about the relationship exists; an array if it does, containing models if they have been loaded, and undefined for those that have not.

      • (): false | (undefined | M)[]

      • Generate a function which returns the value of the given has-many relationship.

        Returns false | (undefined | M)[]

        false if no information about the relationship exists; an array if it does, containing models if they have been loaded, and undefined for those that have not.

Static hasOne

  • hasOne<M>(name: string): () => false | M
  • hasOne<M>(name: string): () => null | false | M

  • Generate a function which returns the value of the given has-one relationship.

    Type parameters

    Parameters

    • name: string

    Returns () => false | M

    false if no information about the relationship exists; undefined if the relationship exists but the model has not been loaded; or the model if it has been loaded.

      • (): false | M

      • Generate a function which returns the value of the given has-one relationship.

        Returns false | M

        false if no information about the relationship exists; undefined if the relationship exists but the model has not been loaded; or the model if it has been loaded.

  • Type parameters

    Parameters

    • name: string

    Returns () => null | false | M

      • (): null | false | M

      • Returns null | false | M

Static transformDate

  • transformDate(value: string): Date
  • transformDate(value: null | string): null | Date
  • transformDate(value: undefined | string): undefined | Date
  • transformDate(value: undefined | null | string): undefined | null | Date

Generated using TypeDoc version 0.22.10