Primitive Docs

Appearance

js-bao

js-bao / ModelRegistry

Class: ModelRegistry ​

Methods ​

clearSessionState() ​

clearSessionState(): void

Returns ​

void

getActiveModels() ​

getActiveModels(): Map<string, typeof BaseModel>

Returns ​

Map<string, typeof BaseModel>

getAllRegisteredModelsInfo() ​

getAllRegisteredModelsInfo(): RegisteredModelInfo[]

Returns ​

RegisteredModelInfo[]

getModelClass() ​

getModelClass(name): typeof BaseModel | undefined

Parameters ​

name ​

string

Returns ​

typeof BaseModel | undefined

getModelInfo() ​

getModelInfo(modelName): RegisteredModelInfo | undefined

Parameters ​

modelName ​

string

Returns ​

RegisteredModelInfo | undefined

getModelOptions() ​

getModelOptions(name): ModelOptions | undefined

Parameters ​

name ​

string

Returns ​

ModelOptions | undefined

initializeAll() ​

initializeAll(yDoc, dbEngine): Promise<void>

Parameters ​

yDoc ​

Doc

dbEngine ​

DatabaseEngine

Returns ​

Promise<void>

initializeAllForDocument() ​

initializeAllForDocument(yDoc, dbEngine, docId, permissionHint): Promise<void>

Parameters ​

yDoc ​

Doc

dbEngine ​

DatabaseEngine

docId ​

string

permissionHint ​

DocumentPermissionHint

Returns ​

Promise<void>

initializeRelationships() ​

initializeRelationships(): Promise<void>

Returns ​

Promise<void>

registerModel() ​

registerModel(modelClass, options, fields): void

Parameters ​

modelClass ​

any

options ​

ModelOptions

fields ​

Map<string, FieldOptions>

Returns ​

void

removeDocumentData() ​

removeDocumentData(docId, dbEngine): Promise<void>

Parameters ​

docId ​

string

dbEngine ​

DatabaseEngine

Returns ​

Promise<void>

setExplicitModelsForSession() ​

setExplicitModelsForSession(modelClasses?): void

Parameters ​

modelClasses? ​

typeof BaseModel[]

Returns ​

void

getInstance() ​

static getInstance(): ModelRegistry

Returns ​

ModelRegistry