Title

Global

Methods

# buildFeature(options) → {FeatureType}

Higher Order Function which creates a feature

Parameters:
Name Type Description
options ResourceOptions

View Source admin-bro/src/backend/utils/build-feature.ts, line 80

FeatureType
Example
const { buildFeature } = require('admin-bro/@core')

const feature = buildFeature({
  // resource options goes here.
})

# mergeResourceOptions(oldOptions, newOptions) → {ResourceOptions}

Merges 2 ResourceOptions together. Used by features

  • 'id', 'href', 'parent', 'sort' from newOptions override oldOptions
  • 'listProperties', 'showProperties', 'editProperties', 'filterProperties' are joined and made unique
  • all 'properties' from newOptions override properties from oldOptions
  • all 'actions' with their parameters from newOptions override oldOptions except hooks and handler - which are chained.
Parameters:
Name Type Description
oldOptions ResourceOptions
newOptions ResourceOptions

View Source admin-bro/src/backend/utils/build-feature.ts, line 25

Type Definitions

object

# NonNullishPartialRecord

NonNullishPartialRecord

Properties:
Name Type Description
{...} V

View Source admin-bro-design-system/src/utils/non-nullish-partial-record.type.ts, line 3

object

# PropertyCustom

Custom (PropertyOptions#custom) properties passed down to the component.

Properties:
Name Type Attributes Description
filePathProperty string
fileProperty string
keyProperty string
fileNameProperty string <optional>
mimeTypeProperty string <optional>
bucketProperty string <optional>
defaultBucket string
mimeTypes Array.<MimeType> <optional>
maxSize number <optional>
provider string

View Source admin-bro-upload/src/features/upload-file/property-custom.type.ts, line 4