@capgo/capacitor-data-storage-sqlite/dist/esm/definitions.d.ts

SQLite Storage of key/value strings pair

export interface CapgoCapacitorDataStorageSqlitePlugin {
    /**
     * Open a store
     * @param options: capOpenStorageOptions
     * @returns Promise<void>
     * @since 0.0.1
     */
    openStore(options: capOpenStorageOptions): Promise<void>;
    /**
     * Close the Store
     * @param options: capStorageOptions
     * @returns Promise<void>
     * @since 3.0.0
     */
    closeStore(options: capStorageOptions): Promise<void>;
    /**
     * Check if the Store is opened
     * @param options: capStorageOptions
     * @returns Promise<capDataStorageResult>
     * @since 3.0.0
     */
    isStoreOpen(options: capStorageOptions): Promise<capDataStorageResult>;
    /**
     * Check if the Store exists
     * @param options: capStorageOptions
     * @returns Promise<capDataStorageResult>
     * @since 3.0.0
     */
    isStoreExists(options: capStorageOptions): Promise<capDataStorageResult>;
    /**
     * Delete a store
     * @param options: capOpenStorageOptions
     * @returns Promise<void>
     * @since 0.0.1
     */
    deleteStore(options: capOpenStorageOptions): Promise<void>;
    /**
     * Set or Add a table to an existing store
     * @param options: capTableStorageOptions
     * @returns Promise<void>
     * @since 0.0.1
     */
    setTable(options: capTableStorageOptions): Promise<void>;
    /**
     * Store a data with given key and value
     * @param options: capDataStorageOptions
     * @returns Promise<void>
     * @since 0.0.1
     */
    set(options: capDataStorageOptions): Promise<void>;
    /**
     * Retrieve a data value for a given data key
     * @param options: capDataStorageOptions
     * @returns Promise<capValueResult>
     * @since 0.0.1
     */
    get(options: capDataStorageOptions): Promise<capValueResult>;
    /**
     * Remove a data with given key
     * @param options: capDataStorageOptions
     * @returns Promise<void>
     * @since 0.0.1
     */
    remove(options: capDataStorageOptions): Promise<void>;
    /**
     * Clear the Data Store (delete all keys)
     * @returns Promise<void>
     * @since 0.0.1
     */
    clear(): Promise<void>;
    /**
     * Check if a data key exists
     * @param options: capDataStorageOptions
     * @returns Promise<capDataStorageResult>
     * @since 0.0.1
     */
    iskey(options: capDataStorageOptions): Promise<capDataStorageResult>;
    /**
     * Get the data key list
     * @returns Promise<capKeysResult>
     * @since 0.0.1
     */
    keys(): Promise<capKeysResult>;
    /**
     * Get the data value list
     * @returns Promise<capValuesResult>
     * @since 0.0.1
     */
    values(): Promise<capValuesResult>;
    /**
     * Get the data value list for filter keys
     * @param options: capFilterStorageOptions
     * @returns Promise<capValuesResult>
     * @since 2.4.2
     */
    filtervalues(options: capFilterStorageOptions): Promise<capValuesResult>;
    /**
     * Get the data key/value pair list
     * @returns Promise<capKeysValuesResult>
     * @since 0.0.1
     */
    keysvalues(): Promise<capKeysValuesResult>;
    /**
     * Check if a table exists
     * @param options: capTableStorageOptions
     * @returns Promise<capDataStorageResult>
     * @since 3.0.0
     */
    isTable(options: capTableStorageOptions): Promise<capDataStorageResult>;
    /**
     * Get the table list for the current store
     * @returns Promise<capTablesResult>
     * @since 3.0.0
     */
    tables(): Promise<capTablesResult>;
    /**
     * Delete a table
     * @param options: capTableStorageOptions
     * @returns Promise<void>
     * @since 3.0.0
     */
    deleteTable(options: capTableStorageOptions): Promise<void>;
    /**
     * Import a database From a JSON
     * @param jsonstring string
     * @returns Promise<capDataStorageChanges>
     * @since 3.2.0
     */
    importFromJson(options: capStoreImportOptions): Promise<capDataStorageChanges>;
    /**
     * Check the validity of a JSON Object
     * @param jsonstring string
     * @returns Promise<capDataStorageResult>
     * @since 3.2.0
     */
    isJsonValid(options: capStoreImportOptions): Promise<capDataStorageResult>;
    /**
     * Export the given database to a JSON Object
     * @returns Promise<capStoreJson>
     * @since 3.2.0
     */
    exportToJson(): Promise<capStoreJson>;
    /**
     * Rebuild the current SQLite store to reclaim unused disk space.
     * @returns Promise<void>
     * @since 8.0.32
     */
    vacuum(): Promise<void>;
    /**
     * Get the native Capacitor plugin version
     *
     * @returns {Promise<{ version: string }>} a Promise with version for this plugin
     * @throws An error if something went wrong
     */
    getPluginVersion(): Promise<{
        version: string;
    }>;
}
export interface capOpenStorageOptions {
    /**
     * The storage database name
     */
    database?: string;
    /**
     * The storage table name
     */
    table?: string;
    /**
     * Set to true for database encryption
     */
    encrypted?: boolean;
    /***
     * Set the mode for database encryption
     * ["encryption", "secret","newsecret"]
     */
    mode?: string;
    /**
     * Set the SQLite auto_vacuum mode for the store.
     *
     * Use `none`/`0`, `full`/`1`, or `incremental`/`2`.
     * iOS, Android, and Electron only. Web ignores this option.
     */
    autoVacuum?: capSQLiteAutoVacuum;
}
export type capSQLiteAutoVacuum = 'none' | 'full' | 'incremental' | 0 | 1 | 2;
export interface capDataStorageOptions {
    /**
     * The data name
     */
    key: string;
    /**
     * The data value when required
     */
    value?: string;
}
export interface capStorageOptions {
    /**
     * The storage name
     */
    database: string;
}
export interface capTableStorageOptions {
    /**
     * The storage table name
     */
    table: string;
}
export interface capFilterStorageOptions {
    /**
     * The filter data for filtering keys
     *
     * ['%filter', 'filter', 'filter%'] for
     * [starts with filter, contains filter, ends with filter]
     */
    filter: string;
}
export interface capDataStorageResult {
    /**
     * result set to true when successful else false
     */
    result?: boolean;
    /**
     * a returned message
     */
    message?: string;
}
export interface capValueResult {
    /**
     * the data value for a given data key
     */
    value: string;
}
export interface capKeysResult {
    /**
     * the data key list as an Array
     */
    keys: string[];
}
export interface capValuesResult {
    /**
     * the data values list as an Array
     */
    values: string[];
}
export interface capKeysValuesResult {
    /**
     * the data keys/values list as an Array of {key:string,value:string}
     */
    keysvalues: any[];
}
export interface capTablesResult {
    /**
     * the tables list as an Array
     */
    tables: string[];
}
export interface JsonStore {
    /**
     * The database name
     */
    database: string;
    /**
     * Set to true (database encryption) / false
     * iOS & Android only
     */
    encrypted: boolean;
    /***
     * Array of Table (JsonTable)
     */
    tables: JsonTable[];
}
export interface JsonTable {
    /**
     * The database name
     */
    name: string;
    /***
     * Array of Values (capDataStorageOptions)
     */
    values?: capDataStorageOptions[];
}
export interface capDataStorageChanges {
    /**
     * the number of changes from an importFromJson command
     */
    changes?: number;
}
export interface capStoreImportOptions {
    /**
     * Set the JSON object to import
     *
     */
    jsonstring?: string;
}
export interface capStoreJson {
    /**
     * an export JSON object
     */
    export?: JsonStore;
}