Documentation

Documentation / @zerotal/admin / index / AdminModel

Interface: AdminModel

Defined in: admin/src/Resource.ts:90

Loosely-typed view of an ORM model class. Row methods are intentionally any so concrete ORM model classes (whose instances lack a string index signature) remain assignable to static model without a cast.

Properties

name?

optional name?: string

Defined in: admin/src/Resource.ts:91

softDeletes?

optional softDeletes?: boolean

Defined in: admin/src/Resource.ts:93

True for models using the SoftDeletes mixin.

Methods

query()?

optional query(): AdminQuery

Defined in: admin/src/Resource.ts:95

Returns

AdminQuery

all()?

optional all(): Promise<any[]>

Defined in: admin/src/Resource.ts:96

Returns

Promise<any[]>

count()?

optional count(): Promise<number>

Defined in: admin/src/Resource.ts:97

Returns

Promise<number>

find()?

optional find(id): Promise<any>

Defined in: admin/src/Resource.ts:98

Parameters

id

unknown

Returns

Promise<any>

create()?

optional create(data): Promise<any>

Defined in: admin/src/Resource.ts:99

Parameters

data

Record<string, unknown>

Returns

Promise<any>

withTrashed()?

optional withTrashed(): AdminQuery

Defined in: admin/src/Resource.ts:101

Soft-delete query scopes (SoftDeletes mixin).

Returns

AdminQuery

onlyTrashed()?

optional onlyTrashed(): AdminQuery

Defined in: admin/src/Resource.ts:102

Returns

AdminQuery