StorageClass | amplify-js

Hierarchy

StorageClass

Implements

object

Index

Constructors

constructor

Methods

Constructors

constructor

new StorageClass(schema: InternalSchema, namespaceResolver: NamespaceResolver, getModelConstructorByModelName: function, modelInstanceCreator: ModelInstanceCreator, adapter?: Adapter, sessionId?: string): StorageClass

- Defined in packages/datastore/src/storage/storage.ts:51
Parameters
- schema: InternalSchema
- namespaceResolver: NamespaceResolver
- getModelConstructorByModelName: function
  - - (namsespaceName: NAMESPACES, modelName: string): PersistentModelConstructor<any>
    - Parameters
      - namsespaceName: NAMESPACES
      - modelName: string
      Returns PersistentModelConstructor<any>
- modelInstanceCreator: ModelInstanceCreator
- Optional adapter: Adapter
- Optional sessionId: string
Returns StorageClass

Methods

batchSave

batchSave<T>(modelConstructor: PersistentModelConstructor<any>, items: ModelInstanceMetadata[], mutator?: Symbol): Promise<[T, OpType][]>

- Defined in packages/datastore/src/storage/storage.ts:326
Type parameters
- T: PersistentModel
Parameters
- modelConstructor: PersistentModelConstructor<any>
- items: ModelInstanceMetadata[]
- Optional mutator: Symbol
Returns Promise<[T, OpType][]>

clear

clear(completeObservable?: boolean): Promise<void>

- Defined in packages/datastore/src/storage/storage.ts:313
Parameters
- Default value completeObservable: boolean = true
Returns Promise<void>

delete

delete<T>(model: T, condition?: ModelPredicate<T>, mutator?: Symbol): Promise<[T[], T[]]>
delete<T>(modelConstructor: PersistentModelConstructor<T>, condition?: ModelPredicate<T>, mutator?: Symbol): Promise<[T[], T[]]>

- Defined in packages/datastore/src/storage/storage.ts:177
Type parameters
- T: PersistentModel
Parameters
- model: T
- Optional condition: ModelPredicate<T>
- Optional mutator: Symbol
Returns Promise<[T[], T[]]>
- Defined in packages/datastore/src/storage/storage.ts:182
Type parameters
- T: PersistentModel
Parameters
- modelConstructor: PersistentModelConstructor<T>
- Optional condition: ModelPredicate<T>
- Optional mutator: Symbol
Returns Promise<[T[], T[]]>

init

init(): Promise<void>

- Defined in packages/datastore/src/storage/storage.ts:80
Returns Promise<void>

observe

observe<T>(modelConstructor?: PersistentModelConstructor<T> | null, predicate?: ModelPredicate<T> | null, skipOwn?: Symbol): Observable<SubscriptionMessage<T>>

- Defined in packages/datastore/src/storage/storage.ts:278
Type parameters
- T: PersistentModel
Parameters
- Optional modelConstructor: PersistentModelConstructor<T> | null
- Optional predicate: ModelPredicate<T> | null
- Optional skipOwn: Symbol
Returns Observable<SubscriptionMessage<T>>

query

query<T>(modelConstructor: PersistentModelConstructor<T>, predicate?: ModelPredicate<T>, pagination?: PaginationInput<T>): Promise<T[]>

- Defined in packages/datastore/src/storage/storage.ts:253
Type parameters
- T: PersistentModel
Parameters
- modelConstructor: PersistentModelConstructor<T>
- Optional predicate: ModelPredicate<T>
- Optional pagination: PaginationInput<T>
Returns Promise<T[]>

queryOne

queryOne<T>(modelConstructor: PersistentModelConstructor<T>, firstOrLast?: QueryOne): Promise<T | undefined>

- Defined in packages/datastore/src/storage/storage.ts:266
Type parameters
- T: PersistentModel
Parameters
- modelConstructor: PersistentModelConstructor<T>
- Default value firstOrLast: QueryOne = QueryOne.FIRST
Returns Promise<T | undefined>

save

save<T>(model: T, condition?: ModelPredicate<T>, mutator?: Symbol, patchesTuple?: [Patch[], PersistentModel]): Promise<[T, INSERT | UPDATE][]>

- Defined in packages/datastore/src/storage/storage.ts:106
Type parameters
- T: PersistentModel
Parameters
- model: T
- Optional condition: ModelPredicate<T>
- Optional mutator: Symbol
- Optional patchesTuple: [Patch[], PersistentModel]
Returns Promise<[T, INSERT | UPDATE][]>

Static getNamespace

getNamespace(): object & object

- Defined in packages/datastore/src/storage/storage.ts:68
Returns object & object

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

schema: InternalSchema

namespaceResolver: NamespaceResolver

getModelConstructorByModelName: function

Parameters

namsespaceName: NAMESPACES

modelName: string

Returns PersistentModelConstructor<any>

modelInstanceCreator: ModelInstanceCreator

Optional adapter: Adapter

Optional sessionId: string

Returns StorageClass

Methods

batchSave

Type parameters

T: PersistentModel

Parameters

modelConstructor: PersistentModelConstructor<any>

items: ModelInstanceMetadata[]

Optional mutator: Symbol

Returns Promise<[T, OpType][]>

clear

Parameters

Default value completeObservable: boolean = true

Returns Promise<void>

delete

Type parameters

T: PersistentModel

Parameters

model: T

Optional condition: ModelPredicate<T>

Optional mutator: Symbol

Returns Promise<[T[], T[]]>

Type parameters

T: PersistentModel

Parameters

modelConstructor: PersistentModelConstructor<T>

Optional condition: ModelPredicate<T>

Optional mutator: Symbol

Returns Promise<[T[], T[]]>

init

Returns Promise<void>

observe

Type parameters

T: PersistentModel

Parameters

Optional modelConstructor: PersistentModelConstructor<T> | null

Optional predicate: ModelPredicate<T> | null

Optional skipOwn: Symbol

Returns Observable<SubscriptionMessage<T>>

query

Type parameters

T: PersistentModel

Parameters

modelConstructor: PersistentModelConstructor<T>

Optional predicate: ModelPredicate<T>

Optional pagination: PaginationInput<T>

Returns Promise<T[]>

queryOne

Type parameters

T: PersistentModel

Parameters

modelConstructor: PersistentModelConstructor<T>

Default value firstOrLast: QueryOne = QueryOne.FIRST

Returns Promise<T | undefined>

save

Type parameters

T: PersistentModel

Parameters

model: T

Optional condition: ModelPredicate<T>

Optional mutator: Symbol

Optional patchesTuple: [Patch[], PersistentModel]