Demo Get Started Join the community
Documentation
Tutorials
01. Installation instructions 02. Adding resources 03. Customize resources 04. Customize actions 05. Writing your own Components 06. Using AdminJS features 07. Customize dashboard 08. Role-Based Access Control 09. Internationalization (i18n) 11. Content Management System

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:

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

Classes

BaseResource

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 245

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 359

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 304

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 371

If there are validation errors it should be thrown

ValidationError

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 263

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 270

String

# decorate() → {BaseDecorator|null}

Gets decorator object for given resource

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

BaseDecorator | null

# async abstract delete(id) → {Promise.<void>}

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 395

If there are validation errors it should be thrown

ValidationError
Promise.<void>

# 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 326

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 346

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 336

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 278

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 285

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 295

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 384

If there are validation errors it should be thrown

ValidationError

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

Promise.<Object>