Skip to content

basalt / admin/src / Resource

Class: Resource ​

Defined in: admin/src/resource.ts:43

Constructors ​

Constructor ​

> new Resource(config): Resource

Defined in: admin/src/resource.ts:48

Parameters ​

config ​

ResourceConfig

Returns ​

Resource

Properties ​

idField ​

> readonly idField: string

Defined in: admin/src/resource.ts:46


label ​

> readonly label: string

Defined in: admin/src/resource.ts:45


name ​

> readonly name: string

Defined in: admin/src/resource.ts:44

Methods ​

columns() ​

> columns(): Field[]

Defined in: admin/src/resource.ts:60

Table columns, honoring the configured order/subset.

Returns ​

Field[]


fields() ​

> fields(): Field[]

Defined in: admin/src/resource.ts:55

All entity fields.

Returns ​

Field[]


formFields() ​

> formFields(mode?): Field[]

Defined in: admin/src/resource.ts:69

Form fields for the given mode (falls back to entity fields minus the id).

Parameters ​

mode? ​

FormMode = 'create'

Returns ​

Field[]


validate() ​

> validate(input, mode?): ValidationResult

Defined in: admin/src/resource.ts:77

Validates input against the mode's schema, mapping errors to field names.

Parameters ​

input ​

unknown

mode? ​

FormMode = 'create'

Returns ​

ValidationResult

Released under the MIT License.