Interface Collection

Hierarchy

_subeuljo
- Collection
  - Collection

Implemented by

Collection

Methods

authOptions

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

Returns CollectionAuthOptions
- Defined in types.d.ts:11597

baseFilesPath

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

Returns string
- Defined in types.d.ts:11559

baseOptions

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

Returns CollectionBaseOptions
- Defined in types.d.ts:11590

decodeOptions

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

getCreated

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

Returns types.DateTime
Inherited from _subeuljo.getCreated
- Defined in types.d.ts:17203

getId

getId(): string
GetId returns the model id.

Returns string
Inherited from _subeuljo.getId
- Defined in types.d.ts:17172

getUpdated

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

Returns types.DateTime
Inherited from _subeuljo.getUpdated
- Defined in types.d.ts:17209

hasId

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

Returns boolean
Inherited from _subeuljo.hasId
- Defined in types.d.ts:17166

isAuth

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

Returns boolean
- Defined in types.d.ts:11571

isBase

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

Returns boolean
- Defined in types.d.ts:11565

isNew

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

Returns boolean
Inherited from _subeuljo.isNew
- Defined in types.d.ts:17197

isView

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

Returns boolean
- Defined in types.d.ts:11577

markAsNew

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

Returns void
Inherited from _subeuljo.markAsNew
- Defined in types.d.ts:17184

markAsNotNew

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

Returns void
Inherited from _subeuljo.markAsNotNew
- Defined in types.d.ts:17190

marshalJSON

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

Returns string | number[]
- Defined in types.d.ts:11583

normalizeOptions

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

Returns void
- Defined in types.d.ts:11611

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 _subeuljo.postScan
- Defined in types.d.ts:17237

refreshCreated

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

Returns void
Inherited from _subeuljo.refreshCreated
- Defined in types.d.ts:17223

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 _subeuljo.refreshId
- Defined in types.d.ts:17217

refreshUpdated

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

Returns void
Inherited from _subeuljo.refreshUpdated
- Defined in types.d.ts:17229

setId

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

setOptions

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

tableName

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

Returns string
- Defined in types.d.ts:11553

viewOptions

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

Returns CollectionViewOptions
- Defined in types.d.ts:11604

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

Generated using TypeDoc