Constructor

# new ViewHelpers()

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 15

Classes

ViewHelpers

Methods

# bulkActionUrl(options) → {string}

Returns bulkAction url

Parameters:

Name	Type	Attributes
`options`	`BulkActionParams`
`resourceId`	`string`
`recordIds`	`Array.<string>`	<optional>
`actionName`	`string`

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 365

Returns:

Type: string

# bulkDeleteUrl(resourceId, recordIds, searchopt) → {string}

Returns url for a `bulkDelete` action in given Resource. Uses bulkActionUrl

Parameters:

Name	Type	Attributes	Description
`resourceId`	`string`		id to the resource
`recordIds`	`Array.<string>`		separated by comma records
`search`	`string`	<optional>	optional query string

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 329

Returns:

Type: string

# dashboardUrl() → {string}

Returns URL for the dashboard

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 263

Returns:

Type: string

# deleteUrl(resourceId, recordId, searchopt) → {string}

Returns url for a `delete` action in given Resource. Uses recordActionUrl

Parameters:

Name	Type	Attributes	Description
`resourceId`	`string`		id to the resource
`recordId`	`string`		id to the record
`search`	`string`	<optional>	optional query string

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 301

Returns:

Type: string

# editUrl(resourceId, recordId, searchopt) → {string}

Returns url for a `edit` action in given Resource. Uses recordActionUrl

Parameters:

Name	Type	Attributes	Description
`resourceId`	`string`		id to the resource
`recordId`	`string`		id to the record
`search`	`string`	<optional>	optional query string

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 281

Returns:

Type: string

# listUrl(resourceId, searchopt) → {string}

Returns url for a `list` action in given Resource. Uses resourceActionUrl

Parameters:

Name	Type	Attributes	Description
`resourceId`	`string`		id to the resource
`search`	`string`	<optional>	optional query string

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 319

Returns:

Type: string

# loginUrl() → {string}

Returns login URL

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 251

Returns:

Type: string

# logoutUrl() → {string}

Returns logout URL

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 257

Returns:

Type: string

# newUrl(resourceId, searchopt) → {string}

Returns url for a `new` action in given Resource. Uses resourceActionUrl

Parameters:

Name	Type	Attributes	Description
`resourceId`	`string`		id to the resource
`search`	`string`	<optional>	optional query string

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 310

Returns:

Type: string

# pageUrl(pageName) → {string}

Returns URL for given page name

Parameters:

Name	Type	Description
`pageName`	`string`	page name which is a unique key specified in AdminJSOptions

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 271

Returns:

Type: string

# recordActionUrl(options) → {string}

Returns recordAction url

Parameters:

Name	Type	Description
`options`	`RecordActionParams`
`resourceId`	`string`
`recordId`	`string`
`actionName`	`string`

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 353

Returns:

Type: string

# resourceActionUrl(options) → {string}

Returns resourceAction url

Parameters:

Name	Type	Attributes	Description
`options`	`ResourceActionParams`
`resourceId`	`string`
`actionName`	`string`
`search`	`string`	<optional>	optional query string

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 341

Returns:

Type: string

# showUrl(resourceId, recordId, searchopt) → {string}

Returns url for a `show` action in given Resource. Uses recordActionUrl

Parameters:

Name	Type	Attributes	Description
`resourceId`	`string`		id to the resource
`recordId`	`string`		id to the record
`search`	`string`	<optional>	optional query string

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 291

Returns:

Type: string

Type Definitions

Type: object

# ActionParams

Base Params for a any function

Properties:

Name	Type	Attributes	Description
`resourceId`	`string`		Unique Resource ID
`actionName`	`string`		Action name
`search`	`string`	<optional>	Optional query string: ?....

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 208

Type: object

# BulkActionParams

Params for a bulk action

Properties:

Name	Type	Attributes	Description
`recordIds`	`Array.<string>`	<optional>	Array of Records ID

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 225

Type: object

# RecordActionParams

Params for a record action

Properties:

Name	Type	Description
`recordId`	`string`	Record ID

View Source adminjs/src/backend/utils/view-helpers/view-helpers.ts, line 217