Class SpecificationRepository

backendAdapter

StaticuseDateFormat

StaticcurrentUser

• get currentUser(): User | undefined

  Returns User | undefined

• set currentUser(user: User | undefined): void

  Parameters

  • user: User | undefined

  Returns void

create

• create<B extends PersistedBaseObject>(obj: B, uid?: string): Promise<any>

  Creates a new persistent record for the provided base object instance.

  Type Parameters

  • B extends PersistedBaseObject

  Parameters

  • obj: B

    The new model instance.

  • Optionaluid: string

    Optional explicit identifier.

  Returns Promise<any>

  A promise resolving to the saved and repopulated model instance.

delete

• delete(uid: string, hardDelete?: boolean): Promise<DataObjectClass<any>>

  delete object in its backend

  Parameters

  • uid: string

    string

  • hardDelete: boolean = false

  Returns Promise<DataObjectClass<any>>

getDataObject

• getDataObject(key: string): Promise<DataObjectClass<any>>

  Internal utility transforming a string key or path into a ready-to-use DataObject.

  Parameters

  • key: string

    The short UID or full database path.

  Returns Promise<DataObjectClass<any>>

  A promise resolving to the newly initialized DataObjectClass.

  Throws

  If key is empty or malformed.

query

• query(query: Query<any>): Promise<QueryResultType<any>>

  Executes an advanced Query using the current repository's backend adapter.

  Parameters

  • query: Query<any>

    The configured Query builder instance.

  Returns Promise<QueryResultType<any>>

  A promise resolving to an array of model instances matching the query.

read

• read(param: string | ObjectUri | ReferenceType): Promise<any>

  Retrieve object from its backend

  Parameters

  • param: string | ObjectUri | ReferenceType

    string | ReferenceType

  Returns Promise<any>

update

• update<B extends PersistedBaseObject>(obj: B): Promise<any>

  Updates an existing database record using the mutated object instance.

  Type Parameters

  • B extends PersistedBaseObject

  Parameters

  • obj: B

    The modified object instance.

  Returns Promise<any>

  A promise resolving to the updated object footprint.