Class Group

constructor

• new Group(data?, store?): Group

• Parameters

  • data: ModelData = {}

    A resource object from the API.

  • store: Store = app.store

    The data store that this model should be persisted to.

  Returns Group

data

exists

freshness

attribute

• attribute<T>(attribute): T

• Get one of the model's attributes.

  Type Parameters

  • T = unknown

  Parameters

  • attribute: string

  Returns T

  Final

delete

• delete(body?, options?): Promise<void>

• Send a request to delete the resource.

  Parameters

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

    Data to send along with the DELETE request.

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

  Returns Promise<void>

id

• id(): undefined | string

• Get the model's ID.

  Returns undefined | string

  Final

pushAttributes

• pushAttributes(attributes): void

• Merge new attributes into this model locally.

  Parameters

  • attributes: ModelAttributes

    The attributes to merge.

  Returns void

pushData

• pushData(data): Group

• Merge new data into this model locally.

  Parameters

  • data: ModelData | {
        relationships?: SaveRelationships;
    }

    A resource object to merge into this model

  Returns Group

save

• save(attributes, options?): Promise<ApiResponseSingle<Group>>

• 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<Group>>

Static attribute

• attribute<T>(name): (() => 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
• attribute<T, O>(name, transform): (() => T)

• Type Parameters

  • T

  • O = unknown

  Parameters

  • name: string

  • transform: ((attr) => T)

    • • (attr): T

      • Parameters

        • attr: O

        Returns T

  Returns (() => T)

  • • (): T

    • Returns T

Static hasMany

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

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

  Type Parameters

  • M extends Model<M>

  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): (() => 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.

  • • (): 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.
• hasOne<M>(name): (() => null | false | M)

• Type Parameters

  • M extends null | Model

  Parameters

  • name: string

  Returns (() => null | false | M)

  • • (): null | false | M

    • Returns null | false | M

Static transformDate

• transformDate(value): Date

• Transform the given value into a Date object.

  Parameters

  • value: string

  Returns Date
• transformDate(value): null | Date

• Parameters

  • value: null | string

  Returns null | Date

• transformDate(value): undefined | Date

• Parameters

  • value: undefined | string

  Returns undefined | Date

• transformDate(value): undefined | null | Date

• Parameters

  • value: undefined | null | string

  Returns undefined | null | Date