Amplify JS API Documentation
    Preparing search index...

    Interface StorageAdapter

    interface StorageAdapter {
        batchSave<T extends Readonly<Record<string, any>>>(
            modelConstructor: PersistentModelConstructor<T>,
            items: ModelInstanceMetadata[],
        ): Promise<[T, OpType][]>;
        clear(): Promise<void>;
        delete<T extends Readonly<Record<string, any>>>(
            modelOrModelConstructor: T | PersistentModelConstructor<T>,
            condition?: ModelPredicate<T>,
        ): Promise<[T[], T[]]>;
        query<T extends Readonly<Record<string, any>>>(
            modelConstructor: PersistentModelConstructor<T>,
            predicate?: ModelPredicate<T>,
            pagination?: PaginationInput<T>,
        ): Promise<T[]>;
        queryOne<T extends Readonly<Record<string, any>>>(
            modelConstructor: PersistentModelConstructor<T>,
            firstOrLast: QueryOne,
        ): Promise<T | undefined>;
        save<T extends Readonly<Record<string, any>>>(
            model: T,
            condition?: ModelPredicate<T>,
        ): Promise<[T, INSERT | UPDATE][]>;
        setUp(
            schema: InternalSchema,
            namespaceResolver: NamespaceResolver,
            modelInstanceCreator: <T extends Readonly<Record<string, any>>>(
                ModelConstructor: PersistentModelConstructor<T>,
                init: Partial<T>,
            ) => T,
            getModelConstructorByModelName: (
                namsespaceName: NAMESPACES,
                modelName: string,
            ) => PersistentModelConstructor<any>,
            appId?: string,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    Index

    Methods

    batchSave clear delete query queryOne save setUp

    Methods

    • Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods