Class

BaseResource

(abstract) BaseResource

Representation of a ORM Resource in AdminJS. Visually resource is a list item in the sidebar. Each resource has many records and many properties.

Analogy is REST resource.

It is an abstract class and all database adapters should implement extend it implement following methods:

Methods

# abstract static isAdapterFor(rawResource) → {Boolean}

Checks if given adapter supports resource provided by the user. This function has to be implemented only if you want to create your custom database adapter.

For one time Admin Resource creation - it is not needed.

Parameters:
Name Type Description
rawResource any

resource provided in AdminJSOptions#resources array

View Source adminjs/src/backend/adapters/resource/base-resource.ts, line 44

if given adapter supports this resource - returns true

Boolean

# build(params) → {BaseRecord}

Builds new Record of given Resource.

Each Record is an representation of the resource item. Before it can be saved, it has to be instantiated.

This function has to be implemented if you want to create new records.

Parameters:
Name Type Description
params Record.<string, any>

View Source adminjs/src/backend/adapters/resource/base-resource.ts, line 164

BaseRecord

# async abstract count(filter) → {Promise.<Number>}

Returns number of elements for given resource by including filters

Parameters:
Name Type Description
filter Filter

represents what data should be included

View Source adminjs/src/backend/adapters/resource/base-resource.ts, line 108

Promise.<Number>

# async abstract create(params) → {Promise.<Object>}

Creates new record

Parameters:
Name Type Description
params Record.<string, any>

View Source adminjs/src/backend/adapters/resource/base-resource.ts, line 176

If there are validation errors it should be thrown

created record converted to raw Object which can be used to initiate new BaseRecord instance

Promise.<Object>

# abstract databaseName() → {String}

The name of the database to which resource belongs. When resource is a mongoose model it should be database name of the mongo database.

Visually, by default, all resources are nested in sidebar under their database names.

View Source adminjs/src/backend/adapters/resource/base-resource.ts, line 63

database name

String

# databaseType() → {String}

Returns type of the database. It is used to compute sidebar icon for given resource. Default: 'database'

View Source adminjs/src/backend/adapters/resource/base-resource.ts, line 71

String

# decorate() → {BaseDecorator|null}

Gets decorator object for given resource

View Source adminjs/src/backend/adapters/resource/base-resource.ts, line 218

BaseDecorator | null

# async abstract delete(id)

Delete given record by id

Parameters:
Name Type Description
id String | Number

id of the Record

View Source adminjs/src/backend/adapters/resource/base-resource.ts, line 199

If there are validation errors it should be thrown

# async abstract find(filters, options) → {Promise.<Array.<BaseRecord>>}

Returns actual records for given resource

Parameters:
Name Type Attributes Description
filters Filter

what data should be included

options Object
limit Number <optional>

how many records should be taken

offset Number <optional>

offset

sort Object <optional>

sort

sort.sortBy Number <optional>

sortable field

sort.direction Number <optional>

either asc or desc

View Source adminjs/src/backend/adapters/resource/base-resource.ts, line 130

list of records

Promise.<Array.<BaseRecord>>
Example
// filters example
{
   name: 'Tom',
   createdAt: { from: '2019-01-01', to: '2019-01-18' }
}

# async findMany(list) → {Promise.<Array.<BaseRecord>>}

Finds many records based on the resource ids

Parameters:
Name Type Description
list Array.<string>

of ids to find

View Source adminjs/src/backend/adapters/resource/base-resource.ts, line 150

records

Promise.<Array.<BaseRecord>>

# async abstract findOne(id) → {Promise.<BaseRecord>|null}

Finds one Record in the Resource by its id

Parameters:
Name Type Description
id String

uniq id of the Resource Record

View Source adminjs/src/backend/adapters/resource/base-resource.ts, line 140

record

Promise.<BaseRecord> | null

# abstract id() → {String}

Each resource has to have uniq id which will be put to an URL of AdminJS routes. For instance in Router path for the new form is /resources/{resourceId}/new

View Source adminjs/src/backend/adapters/resource/base-resource.ts, line 80

uniq resource id

String

# abstract properties() → {Array.<BaseProperty>}

returns array of all properties which belongs to resource

View Source adminjs/src/backend/adapters/resource/base-resource.ts, line 88

Array.<BaseProperty>

# abstract property(path) → {BaseProperty|null}

returns property object for given field

Parameters:
Name Type Description
path String

path/name of the property. Take a look at BaseProperty to learn more about property paths.

View Source adminjs/src/backend/adapters/resource/base-resource.ts, line 99

BaseProperty | null

# async abstract update(id, params) → {Promise.<Object>}

Updates an the record.

Parameters:
Name Type Description
id String

uniq id of the Resource Record

params Record.<string, any>

View Source adminjs/src/backend/adapters/resource/base-resource.ts, line 189

If there are validation errors it should be thrown

created record converted to raw Object which can be used to initiate new BaseRecord instance

Promise.<Object>