Class ExtensionReadme

data

exists

freshness

attribute

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

  Get one of the model's attributes.

  Type Parameters

  • T = unknown

  Parameters

  • attribute: string

  Returns T

  Final

delete

• delete(
      body?:
          | Document
          | XMLHttpRequestBodyInit
          | object & { [id: string]: any }
          | null
          | undefined,
      options?: Omit<FlarumRequestOptions<void>, "url">,
  ): Promise<void>

  Send a request to delete the resource.

  Parameters

  • body:
        | Document
        | XMLHttpRequestBodyInit
        | object & { [id: string]: any }
        | null
        | undefined = {}

    Data to send along with the DELETE request.

  • options: Omit<FlarumRequestOptions<void>, "url"> = {}

  Returns Promise<void>

id

• id(): string | undefined

  Get the model's ID.

  Returns string | undefined

  Final

pushAttributes

• pushAttributes(attributes: ModelAttributes): void

  Merge new attributes into this model locally.

  Parameters

  • attributes: ModelAttributes

    The attributes to merge.

  Returns void

pushData

• pushData(data: ModelData | { relationships?: SaveRelationships }): this

  Merge new data into this model locally.

  Parameters

  • data: ModelData | { relationships?: SaveRelationships }

    A resource object to merge into this model

  Returns this

save

• save(
      attributes: SaveAttributes,
      options?: Omit<FlarumRequestOptions<ApiPayloadSingle>, "url"> & {
          meta?: MetaInformation;
      },
  ): Promise<ApiResponseSingle<ExtensionReadme>>

  Merge new attributes into this model, both locally and with persistence.

  Parameters

  • attributes: SaveAttributes

    The attributes to save. If a 'relationships' key exists, it will be extracted and relationships will also be saved.

  • options: Omit<FlarumRequestOptions<ApiPayloadSingle>, "url"> & { meta?: MetaInformation } = {}

  Returns Promise<ApiResponseSingle<ExtensionReadme>>

Staticattribute

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

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

  Type Parameters

  • T

  Parameters

  • name: string

  Returns () => T

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

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

  Type Parameters

  • T
  • O = unknown

  Parameters

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

    A function to transform the attribute value

  Returns () => T

StatichasMany

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

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

  Type Parameters

  • M extends Model<M>

  Parameters

  • name: string

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

  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.

StatichasOne

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

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

  Type Parameters

  • M extends Model<M>

  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.

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

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

  Type Parameters

  • M extends Model | null

  Parameters

  • name: string

  Returns () => false | M | null

  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.

StatictransformDate

• transformDate(value: string): Date

  Transform the given value into a Date object.

  Parameters

  • value: string

  Returns Date

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

  Transform the given value into a Date object.

  Parameters

  • value: string | null

  Returns Date | null

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

  Transform the given value into a Date object.

  Parameters

  • value: string | undefined

  Returns Date | undefined

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

  Transform the given value into a Date object.

  Parameters

  • value: string | null | undefined

  Returns Date | null | undefined