AWS Amplify JS Dev Center
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • DataStore

Index

Methods

Methods

clear

  • Clears all data from storage and removes all data, schema info, other initialization details, and then stops DataStore.

    That said, reinitialization is required after clearing. This can be done by explicitiliy calling start() or any method that implicitly starts DataStore, such as query(), save(), or delete().

    Returns Promise<void>

configure

delete

getModuleName

  • getModuleName(): string

handleAddProcError

  • handleAddProcError(operation: string): handler

  • Builds a function to capture BackgroundManagerNotOpenError's to produce friendlier, more instructive errors for customers.

    Parameters

    • operation: string

      The name of the operation (usually a Datastore method) the customer tried to call.

    Returns handler

observe

observeQuery

query

save

setConflictHandler

setErrorHandler

start

  • If not already done:

    1. Attaches and initializes storage.
    2. Loads the schema and records metadata.
    3. If this.amplifyConfig.aws_appsync_graphqlEndpoint contains a URL, attaches a sync engine, starts it, and subscribes.

    Returns Promise<void>

stop

  • stop(this: InstanceType<typeof DataStore>): Promise<void>