Back to Pocketbase

Interface Settings

static/jsvm/interfaces/core.Settings.html

latest4.1 KB
Original Source

Interface Settings

Settings defines the PocketBase app settings.

Hierarchy

Index

Methods

clonedbExportisNewlastSavedPKmarkAsNewmarkAsNotNewmarshalJSONmergepkpostScanpostValidatestringtableName

Properties

backupsbatchlogsmetarateLimitss3smtptrustedProxy

Methods

clone

Clone creates a new deep copy of the current settings.

Returns Settings

dbExport

DBExport prepares and exports the current settings for db persistence.

Parameters

app: App

Returns _TygojaDict

isNew

  • isNew(): boolean

IsNew implements [Model.IsNew] interface method.

Returns boolean

lastSavedPK

  • lastSavedPK(): any

PK implements [Model.LastSavedPK] interface method.

Returns any

markAsNew

  • markAsNew(): void

MarkAsNew implements [Model.MarkAsNew] interface method.

Returns void

markAsNotNew

  • markAsNotNew(): void

MarkAsNew implements [Model.MarkAsNotNew] interface method.

Returns void

marshalJSON

  • marshalJSON(): string | number[]

MarshalJSON implements the [json.Marshaler] interface.

Note that sensitive fields (S3 secret, SMTP password, etc.) are excluded.

Returns string | number[]

merge

  • merge(other): void

Merge merges the "other" settings into the current one.

Parameters

other: Settings

Returns void

pk

  • pk(): any

PK implements [Model.PK] interface method.

Returns any

postScan

  • postScan(): void

PostScan implements [Model.PostScan] interface method.

Returns void

postValidate

  • postValidate(ctx, app): void

PostValidate implements the [PostValidator] interface and defines the Settings model validations.

Parameters

ctx: context.Context
app: App

Returns void

string

  • string(): string

String returns a serialized string representation of the current settings.

Returns string

tableName

  • tableName(): string

TableName implements [Model.TableName] interface method.

Returns string

Properties

backups

backups: BackupsConfig

batch

batch: BatchConfig

logs

logs: LogsConfig

meta

meta: MetaConfig

rateLimits

rateLimits: RateLimitsConfig

s3

s3: S3Config

smtp

smtp: SMTPConfig

trustedProxy

trustedProxy: TrustedProxyConfig

Settings

Member Visibility

  • Inherited

Theme

OSLightDark

On This Page

Generated using TypeDoc