Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace autoSaveService

Auto Save Service

Helper functions for handling data while user is completing form.

import { autoSaveService } from '@oneblink/apps'

Index

Functions

Functions

deleteAllAutosaveData

  • deleteAllAutosaveData(): Promise<void>

deleteAutoSaveData

  • deleteAutoSaveData(formId: number, autoSaveKey: undefined | null | string): Promise<void>

  • Delete saved data.

    Example

     
    const formId = 1
    const myKey = 'my-key'
    await autoSaveService.deleteAutoSaveData(formId, myKey)

    Parameters

    • formId: number
    • autoSaveKey: undefined | null | string

    Returns Promise<void>

getAutoSaveData

  • getAutoSaveData<T>(formId: number, autoSaveKey: undefined | null | string): Promise<T | null>

  • Get saved data.

    Example

     
    const formId = 1
    const myKey = 'my-key'
    const prefillData = await autoSaveService.getAutoSaveData(formId, myKey)
    if (prefillData) {
      // Ask user if they would like to continue with this prefill data.
    }

    Type parameters

    • T

    Parameters

    • formId: number
    • autoSaveKey: undefined | null | string

    Returns Promise<T | null>

getAutoSaveKeys

  • getAutoSaveKeys(): Promise<string[]>

  • Get keys for autosave data.

    Example

     
    const keys = await autoSaveService.getAutoSaveDataKeys()
    if (keys.length) {
      // Display keys to user
    }

    Returns Promise<string[]>

upsertAutoSaveData

  • upsertAutoSaveData<T>(formId: number, autoSaveKey: undefined | null | string, model: T): Promise<T>

  • Create or update saved data.

    Example

     
    const formId = 1
    const myKey = 'my-key'
    await autoSaveService.upsertAutoSaveData(formId, myKey, {
      form: 'data',
      goes: 'here',
    })

    Type parameters

    • T: Record<string, unknown>

    Parameters

    • formId: number
    • autoSaveKey: undefined | null | string
    • model: T

    Returns Promise<T>