Class CollectionUpsertForm

CollectionUpsert is a [models.Collection] upsert (create/update) form.

Hierarchy

CollectionUpsert
- CollectionUpsertForm

Implements

CollectionUpsert

Index

Constructors

Methods

setDao submit validate

Properties

createRule? deleteRule? id indexes listRule? name options schema system type updateRule? viewRule?

Constructors

constructor

new CollectionUpsertForm(app, collection): CollectionUpsertForm
Parameters
- app: excludeHooks<App>
- collection: models.Collection
Returns CollectionUpsertForm
Inherited from forms.CollectionUpsert.constructor
- Defined in types.d.ts:777

Methods

setDao

setDao(dao): void
SetDao replaces the default form Dao instance with the provided one.
Parameters
- dao: daos.Dao
Returns void
Inherited from CollectionUpsert.setDao
- Defined in types.d.ts:5702

submit

submit(...interceptors): void
Submit validates the form and upserts the form's Collection model.

On success the related record table schema will be auto updated.

You can optionally provide a list of InterceptorFunc to further modify the form behavior before persisting it.
Parameters
- Rest ...interceptors: InterceptorFunc<models.Collection>[]
Returns void
Inherited from CollectionUpsert.submit
- Defined in types.d.ts:5719

validate

validate(): void
Validate makes the form validatable by implementing [validation.Validatable] interface.

Returns void
Inherited from CollectionUpsert.validate
- Defined in types.d.ts:5708

Properties

`Optional` createRule

createRule?: string

`Optional` deleteRule

deleteRule?: string

id

id: string

indexes

indexes: JsonArray<string>

`Optional` listRule

listRule?: string

name

name: string

options

options: JsonMap

schema

schema: schema.Schema

system

system: boolean

type

type: string

`Optional` updateRule

updateRule?: string

`Optional` viewRule

viewRule?: string

Generated using TypeDoc