Class Collection

Collection model class.

const collection = new Collection({
    name:       "article",
    type:       "base",
    listRule:   "@request.auth.id != '' || status = 'public'",
    viewRule:   "@request.auth.id != '' || status = 'public'",
    deleteRule: "@request.auth.id != ''",
    schema: [
        {
            name: "title",
            type: "text",
            required: true,
            options: { min: 6, max: 100 },
        },
        {
            name: "description",
            type: "text",
        },
    ]
})

Hierarchy

models.Collection
- Collection

Implements

models.Collection

Constructors

constructor

new Collection(data?): Collection
Parameters
- Optional data: Partial<models.Collection>
Returns Collection
Inherited from models.Collection.constructor
- Defined in types.d.ts:300

Methods

authOptions

authOptions(): CollectionAuthOptions
AuthOptions decodes the current collection options and returns them as new [CollectionAuthOptions] instance.

Returns CollectionAuthOptions
Inherited from Collection.authOptions
- Defined in types.d.ts:11301

baseFilesPath

baseFilesPath(): string
BaseFilesPath returns the storage dir path used by the collection.

Returns string
Inherited from Collection.baseFilesPath
- Defined in types.d.ts:11263

baseOptions

baseOptions(): CollectionBaseOptions
BaseOptions decodes the current collection options and returns them as new [CollectionBaseOptions] instance.

Returns CollectionBaseOptions
Inherited from Collection.baseOptions
- Defined in types.d.ts:11294

decodeOptions

decodeOptions(result): void
DecodeOptions decodes the current collection options into the provided "result" (must be a pointer).
Parameters
- result: any
Returns void
Inherited from Collection.decodeOptions
- Defined in types.d.ts:11322

getCreated

getCreated(): types.DateTime
GetCreated returns the model Created datetime.

Returns types.DateTime
Inherited from Collection.getCreated
- Defined in types.d.ts:16364

getId

getId(): string
GetId returns the model id.

Returns string
Inherited from Collection.getId
- Defined in types.d.ts:16333

getUpdated

getUpdated(): types.DateTime
GetUpdated returns the model Updated datetime.

Returns types.DateTime
Inherited from Collection.getUpdated
- Defined in types.d.ts:16370

hasId

hasId(): boolean
HasId returns whether the model has a nonzero id.

Returns boolean
Inherited from Collection.hasId
- Defined in types.d.ts:16327

isAuth

isAuth(): boolean
IsAuth checks if the current collection has "auth" type.

Returns boolean
Inherited from Collection.isAuth
- Defined in types.d.ts:11275

isBase

isBase(): boolean
IsBase checks if the current collection has "base" type.

Returns boolean
Inherited from Collection.isBase
- Defined in types.d.ts:11269

isNew

isNew(): boolean
IsNew indicates what type of db query (insert or update) should be used with the model instance.

Returns boolean
Inherited from Collection.isNew
- Defined in types.d.ts:16358

isView

isView(): boolean
IsView checks if the current collection has "view" type.

Returns boolean
Inherited from Collection.isView
- Defined in types.d.ts:11281

markAsNew

markAsNew(): void
MarkAsNew marks the model as "new" (aka. enforces m.IsNew() to be true).

Returns void
Inherited from Collection.markAsNew
- Defined in types.d.ts:16345

markAsNotNew

markAsNotNew(): void
MarkAsNotNew marks the model as "not new" (aka. enforces m.IsNew() to be false)

Returns void
Inherited from Collection.markAsNotNew
- Defined in types.d.ts:16351

marshalJSON

marshalJSON(): string | number[]
MarshalJSON implements the [json.Marshaler] interface.

Returns string | number[]
Inherited from Collection.marshalJSON
- Defined in types.d.ts:11287

normalizeOptions

normalizeOptions(): void
NormalizeOptions updates the current collection options with a new normalized state based on the collection type.

Returns void
Inherited from Collection.normalizeOptions
- Defined in types.d.ts:11315

postScan

postScan(): void
PostScan implements the [dbx.PostScanner] interface.

It is executed right after the model was populated with the db row values.

Returns void
Inherited from Collection.postScan
- Defined in types.d.ts:16398

refreshCreated

refreshCreated(): void
RefreshCreated updates the model Created field with the current datetime.

Returns void
Inherited from Collection.refreshCreated
- Defined in types.d.ts:16384

refreshId

refreshId(): void
RefreshId generates and sets a new model id.

The generated id is a cryptographically random 15 characters length string.

Returns void
Inherited from Collection.refreshId
- Defined in types.d.ts:16378

refreshUpdated

refreshUpdated(): void
RefreshUpdated updates the model Updated field with the current datetime.

Returns void
Inherited from Collection.refreshUpdated
- Defined in types.d.ts:16390

setId

setId(id): void
SetId sets the model id to the provided string value.
Parameters
- id: string
Returns void
Inherited from Collection.setId
- Defined in types.d.ts:16339

setOptions

setOptions(typedOptions): void
SetOptions normalizes and unmarshals the specified options into m.Options.
Parameters
- typedOptions: any
Returns void
Inherited from Collection.setOptions
- Defined in types.d.ts:11328

tableName

tableName(): string
TableName returns the Collection model SQL table name.

Returns string
Inherited from Collection.tableName
- Defined in types.d.ts:11257

viewOptions

viewOptions(): CollectionViewOptions
ViewOptions decodes the current collection options and returns them as new [CollectionViewOptions] instance.

Returns CollectionViewOptions
Inherited from Collection.viewOptions
- Defined in types.d.ts:11308

Properties

`Optional` createRule

createRule?: string

created

created: types.DateTime

`Optional` deleteRule

deleteRule?: string

id

id: string

indexes

indexes: JsonArray<string>

`Optional` listRule

listRule?: string

rules

name

name: string

options

options: JsonMap

schema

schema: schema.Schema

system

system: boolean

type

type: string

`Optional` updateRule

updateRule?: string

updated

updated: types.DateTime

`Optional` viewRule

viewRule?: string

Class Collection

Hierarchy

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Optional data: Partial<models.Collection>

Returns Collection

Methods

authOptions

Returns CollectionAuthOptions

baseFilesPath

Returns string

baseOptions

Returns CollectionBaseOptions

decodeOptions

Parameters

result: any

Returns void

getCreated

Returns types.DateTime

getId

Returns string

getUpdated

Returns types.DateTime

hasId

Returns boolean

isAuth

Returns boolean

isBase

Returns boolean

isNew

Returns boolean

isView

Returns boolean

markAsNew

Returns void

markAsNotNew

Returns void

marshalJSON

Returns string | number[]

normalizeOptions

Returns void

postScan

Returns void

refreshCreated

Returns void

refreshId

Returns void

refreshUpdated

Returns void

setId

Parameters

id: string

Returns void

setOptions

Parameters

typedOptions: any

Returns void

tableName

Returns string

viewOptions

Returns CollectionViewOptions

Properties

Optional createRule

created

Optional deleteRule

id

indexes

Optional listRule

name

options

schema

system

type

Optional updateRule

`Optional` data: Partial<models.Collection>

`Optional` createRule

`Optional` deleteRule

`Optional` listRule

`Optional` updateRule

`Optional` viewRule