Class Model`Abstract`

The Model class represents a local data resource. It provides methods to persist changes via the API.

Hierarchy

Model
- ExtensionReadme
- AccessToken
- Discussion
- Forum
- Group
- Notification
- Post
- User

Index

Constructors

constructor

new Model(data?: ModelData, store?: Store): Model
Parameters
- data: ModelData = {}
  
  A resource object from the API.
- store: Store = app.store
  
  The data store that this model should be persisted to.
Returns Model
- Defined in src/common/Model.ts:76

Properties

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
Construct a path to the API endpoint for this resource.

Returns string
- Defined in src/common/Model.ts:278

attribute

attribute<T>(attribute: string): T
Get one of the model's attributes.

Final
Type Parameters
- T = unknown
Parameters
- attribute: string
Returns T
- Defined in src/common/Model.ts:95

`Protected` copyData

copyData(): ModelData
Returns ModelData
- Defined in src/common/Model.ts:282

delete

delete(body?: undefined | null | Document | XMLHttpRequestBodyInit | object & {
[id: string]: any;
}, options?: Omit<FlarumRequestOptions<void>, "url">): 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>
- Defined in src/common/Model.ts:258

id

id(): undefined | string
Get the model's ID.

Final

Returns undefined | string
- Defined in src/common/Model.ts:86

pushAttributes

pushAttributes(attributes: ModelAttributes): void
Merge new attributes into this model locally.
Parameters
- attributes: ModelAttributes
  
  The attributes to merge.
Returns void
- Defined in src/common/Model.ts:174

pushData

pushData(data: ModelData | {
relationships?: SaveRelationships;
}): Model
Merge new data into this model locally.
Parameters
- data: ModelData | {
  relationships?: SaveRelationships;
  }
  
  A resource object to merge into this model
Returns Model
- Defined in src/common/Model.ts:104

`Protected` rawRelationship

rawRelationship<M>(relationship: string): undefined | ModelIdentifier
Type Parameters
- M extends Model<M>
Parameters
- relationship: string
Returns undefined | ModelIdentifier
- Defined in src/common/Model.ts:286
rawRelationship<M>(relationship: string): undefined | ModelIdentifier[]
Type Parameters
- M extends Model[]
Parameters
- relationship: string
Returns undefined | ModelIdentifier[]
- Defined in src/common/Model.ts:287

save

save(attributes: SaveAttributes, options?: Omit<FlarumRequestOptions<ApiPayloadSingle>, "url"> & {
meta?: MetaInformation;
}): Promise<ApiResponseSingle<Model>>
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<Model>>
- Defined in src/common/Model.ts:184

`Static` attribute

attribute<T>(name: string): (() => 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
- Defined in src/common/Model.ts:297
attribute<T, O>(name: string, transform: ((attr: O) => T)): (() => 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
- Defined in src/common/Model.ts:298

`Static` `Protected` getIdentifier

getIdentifier(model: Model): ModelIdentifier
Get a resource identifier object for the given model.
Parameters
- model: Model
Returns ModelIdentifier
- Defined in src/common/Model.ts:373

`Static` hasMany

hasMany<M>(name: string): (() => false | (undefined | M)[])
Generate a function which returns the value of the given has-many relationship.

Returns
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.
Type Parameters
- M extends Model<M>
Parameters
- name: string
Returns (() => false | (undefined | M)[])
- - (): false | (undefined | M)[]
  - Generate a function which returns the value of the given has-many relationship.
    
    Returns
    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.
    
    Returns false | (undefined | M)[]
- Defined in src/common/Model.ts:343

`Static` hasOne

hasOne<M>(name: string): (() => false | M)
Generate a function which returns the value of the given has-one relationship.

Returns
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
- M extends Model<M>
Parameters
- name: string
Returns (() => false | M)
- - (): false | M
  - Generate a function which returns the value of the given has-one relationship.
    
    Returns
    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.
    
    Returns false | M
- Defined in src/common/Model.ts:317
hasOne<M>(name: string): (() => null | false | M)
Type Parameters
- M extends null | Model
Parameters
- name: string
Returns (() => null | false | M)
- - (): null | false | M
  - Returns null | false | M
- Defined in src/common/Model.ts:318

`Static` transformDate

transformDate(value: string): Date
Transform the given value into a Date object.
Parameters
- value: string
Returns Date
- Defined in src/common/Model.ts:362
transformDate(value: null | string): null | Date
Parameters
- value: null | string
Returns null | Date
- Defined in src/common/Model.ts:363
transformDate(value: undefined | string): undefined | Date
Parameters
- value: undefined | string
Returns undefined | Date
- Defined in src/common/Model.ts:364
transformDate(value: undefined | null | string): undefined | null | Date
Parameters
- value: undefined | null | string
Returns undefined | null | Date
- Defined in src/common/Model.ts:365

Class ModelAbstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

data: ModelData = {}

store: Store = app.store

Returns Model

Properties

data

exists

freshness

Protected store

Methods

Protected apiEndpoint

Returns string

attribute

Final

Type Parameters

T = unknown

Parameters

attribute: string

Returns T

Protected copyData

Returns ModelData

delete

Parameters

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

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

Returns Promise<void>

id

Final

Returns undefined | string

pushAttributes

Parameters

attributes: ModelAttributes

Returns void

pushData

Parameters

data: ModelData | { relationships?: SaveRelationships; }

Returns Model

Protected rawRelationship

Type Parameters

M extends Model<M>

Parameters

relationship: string

Returns undefined | ModelIdentifier

Type Parameters

M extends Model[]

Parameters

relationship: string

Returns undefined | ModelIdentifier[]

save

Parameters

attributes: SaveAttributes

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

Returns Promise<ApiResponseSingle<Model>>

Static attribute

Type Parameters

T

Parameters

name: string

Returns (() => T)

Returns T

Type Parameters

T

O = unknown

Parameters

name: string

transform: ((attr: O) => T)

Parameters

attr: O

Returns T

Returns (() => T)

Returns T

Static Protected getIdentifier

Class Model`Abstract`

`Protected` store

`Protected` apiEndpoint

`Protected` copyData

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

data: ModelData | {
relationships?: SaveRelationships;
}

`Protected` rawRelationship

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

`Static` attribute

`Static` `Protected` getIdentifier

`Static` hasMany

`Static` hasOne

`Static` transformDate