Class BaseCollection<T>

Represents a collection of some models that extends from BaseModel instances. BaseCollection is basically a wrapper around array of Models

Type Parameters

T extends BaseModel
Type parameter extending BaseModel.

Hierarchy (view full)

MetaClass
- BaseCollection

Index

Constructors

constructor

new BaseCollection<T>(data?): BaseCollection<T>
Constructs a new BaseCollection.
Type Parameters
- T extends BaseModel
Parameters
- data: any = []
  Initial data for the collection.
Returns BaseCollection<T>
Overrides MetaClass.constructor
- Defined in BaseCollection.ts:20

Properties

_listeners

_listeners: Listeners = {}

Event listeners registered for this instance.

_uid

_uid: string = ...

Unique identifier for the instance.

loading

loading: boolean = false

Indicates if the collection is currently loading.

models

models: T[]

The array of models in the collection.

Accessors

$class

get $class(): string
Gets the class name of this instance.

Returns string
Inherited from MetaClass.$class
- Defined in MetaClass.ts:30

Methods

add

add(item): void
Adds a model to the collection. If the provided item is a plain object, it is converted into a model before adding.
Parameters
- item: any
  The item to add.
Returns void
- Defined in BaseCollection.ts:85

apiFunctions

apiFunctions(): Endpoints
Returns a map of API functions with default values.

Returns Endpoints
An object containing API functions.
Inherited from MetaClass.apiFunctions
- Defined in MetaClass.ts:132

bulkCreateOrUpdate

bulkCreateOrUpdate(payload?): Promise<any>
Initiates a bulk create or update operation using provided payload.
Parameters
- payload: any = null
  The payload for the bulk create or update operation.
Returns Promise<any>
A Promise representing the bulk create or update operation.
Inherited from MetaClass.bulkCreateOrUpdate
- Defined in MetaClass.ts:98

bulkDelete

bulkDelete(payload?): Promise<any>
Initiates a bulk delete operation using provided payload.
Parameters
- payload: any = null
  The payload for the bulk delete operation.
Returns Promise<any>
A Promise representing the bulk delete operation.
Inherited from MetaClass.bulkDelete
- Defined in MetaClass.ts:89

create

create(payload?): Promise<any>
Initiates a create operation using provided payload.
Parameters
- payload: any = null
  The payload for the create operation.
Returns Promise<any>
A Promise representing the create operation.
Inherited from MetaClass.create
- Defined in MetaClass.ts:53

createMeta

createMeta(): void
Initializes or resets metadata for the instance.

Returns void
Inherited from MetaClass.createMeta
- Defined in MetaClass.ts:23

createModel

createModel(attributes): undefined | T
Creates a new model instance with the provided attributes.
Parameters
- attributes: any
  The attributes for the new model.
Returns undefined | T
- The created model instance, or undefined if model is not defined.
- Defined in BaseCollection.ts:56

delete

delete(payload?): Promise<any>
Initiates a delete operation using provided payload.
Parameters
- payload: any = null
  The payload for the delete operation.
Returns Promise<any>
A Promise representing the delete operation.
Inherited from MetaClass.delete
- Defined in MetaClass.ts:80

doWithLoading

doWithLoading(func, ...args): Promise<any>
Performs an asynchronous operation with loading indicator.
Parameters
- func: Function
  The function to execute.
- Rest ...args: any[]
  Additional arguments for the function.
Returns Promise<any>
A Promise representing the result of the operation.
Inherited from MetaClass.doWithLoading
- Defined in MetaClass.ts:121

dropModels

dropModels(): void
Clears the collection by removing all models.

Returns void
- Defined in BaseCollection.ts:65

emit

emit(event, ...args): void
Emits an event by name to all registered listeners on that event. Listeners will be called in the order that they were added. If a listener returns false, no other listeners will be called.
Parameters
- event: any
  The name of the event to emit.
- Rest ...args: any[]
  The context of the event, passed to listeners.
Returns void
Inherited from MetaClass.emit
- Defined in MetaClass.ts:152

fetch

fetch(payload?): Promise<any>
Initiates a fetch operation using provided payload.
Parameters
- payload: any = null
  The payload for the fetch operation.
Returns Promise<any>
A Promise representing the fetch operation.
Inherited from MetaClass.fetch
- Defined in MetaClass.ts:44

findIndex

findIndex(item): number
Finds the index of a model in the collection based on its unique ID (_uid).
Parameters
- item: T
  The model to find.
Returns number
- The index of the model in the collection, or -1 if not found.
- Defined in BaseCollection.ts:98

get

get(): T[]
Retrieves the models in the collection.

Returns T[]
- The array of models in the collection.
- Defined in BaseCollection.ts:127

makeRequest

makeRequest(payload, reqFunc): Promise<any>
Makes a request using the provided request function and payload.
Parameters
- payload: any
  The payload for the request.
- reqFunc: any
  The request function to execute.
Returns Promise<any>
A Promise representing the request operation.
Inherited from MetaClass.makeRequest
- Defined in MetaClass.ts:108

model

model(): undefined | null | typeof BaseModel | T
Returns the model type or constructor for the collection.

Returns undefined | null | typeof BaseModel | T
- The model type or constructor.
- Defined in BaseCollection.ts:47

on

on(event, listener): void
Registers an event listener for a given event.

Event names can be comma-separated to register multiple events.
Parameters
- event: string
  The name of the event to listen for.
- listener: Function
  The event listener, accepts context.
Returns void
Inherited from MetaClass.on
- Defined in MetaClass.ts:172

override

override(item): void
Overrides a model in the collection with a new model instance. If the model to override is not found, no action is taken.
Parameters
- item: T
  The new model instance to use for override.
Returns void
- Defined in BaseCollection.ts:117

read

read(payload?): Promise<any>
Initiates a read operation using provided payload.
Parameters
- payload: any = null
  The payload for the read operation.
Returns Promise<any>
A Promise representing the read operation.
Inherited from MetaClass.read
- Defined in MetaClass.ts:62

remove

remove(item): void
Removes a model from the collection.
Parameters
- item: T
  The model to remove.
Returns void
- Defined in BaseCollection.ts:105

set

set(data): void
Sets the models in the collection.
Parameters
- data: any
  The data to set as models.
Returns void
- Defined in BaseCollection.ts:73

toString

toString(): string
Returns a string representation of this instance.

Returns string
Inherited from MetaClass.toString
- Defined in MetaClass.ts:35

transformModels

transformModels(data): T[]
Transforms the provided data into models.
Parameters
- data: T[]
  The data to transform.
Returns T[]
- The transformed models.
Example
```
// A common use case for vue.js where you can redefine it like so
transformModels(data: T[]): T[] {
  return reactive(data); 
}
```
- Defined in BaseCollection.ts:39

update

update(payload?): Promise<any>
Initiates an update operation using provided payload.
Parameters
- payload: any = null
  The payload for the update operation.
Returns Promise<any>
A Promise representing the update operation.
Inherited from MetaClass.update
- Defined in MetaClass.ts:71

Class BaseCollection<T>

Type Parameters

T extends BaseModel

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends BaseModel

Parameters

data: any = []

Returns BaseCollection<T>

Properties

_listeners

_uid

loading

models

Accessors

$class

Returns string

Methods

add

Parameters

item: any

Returns void

apiFunctions

Returns Endpoints

bulkCreateOrUpdate

Parameters

payload: any = null

Returns Promise<any>

bulkDelete

Parameters

payload: any = null

Returns Promise<any>

create

Parameters

payload: any = null

Returns Promise<any>

createMeta

Returns void

createModel

Parameters

attributes: any

Returns undefined | T

delete

Parameters

payload: any = null

Returns Promise<any>

doWithLoading

Parameters

func: Function

Rest ...args: any[]

Returns Promise<any>

dropModels

Returns void

emit

Parameters

event: any

Rest ...args: any[]

Returns void

fetch

Parameters

payload: any = null

Returns Promise<any>

findIndex

Parameters

item: T

Returns number

get

Returns T[]

makeRequest

Parameters

payload: any

reqFunc: any

Returns Promise<any>

`Rest` ...args: any[]

`Rest` ...args: any[]