Options
All
  • Public
  • Public/Protected
  • All
Menu

@xweb3/swr-store - v0.0.19

Index

Functions

Functions

completedMiddleware

  • completedMiddleware(useSWRNext: (arg0: any, arg1: any, arg2: any) => any): (key: any, fetcher: any, config: any) => any

  • Parameters

    • useSWRNext: (arg0: any, arg1: any, arg2: any) => any
        • (arg0: any, arg1: any, arg2: any): any

        • Parameters

          • arg0: any
          • arg1: any
          • arg2: any

          Returns any

    Returns (key: any, fetcher: any, config: any) => any

      • (key: any, fetcher: any, config: any): any

      • Parameters

        • key: any
        • fetcher: any
        • config: any

        Returns any

findDataByFilter

  • findDataByFilter(data: any[], filter: Record<any, any>): any

useCompleted

  • useCompleted(key: any, callback: (data: any) => any, update?: boolean): any

  • Data calculation and storage

    Get 'useSWR' cache data through key, Use callback for data filtering, Use the key and callback to cache the data for newkey. The data will be fetched from the cache next time.

    example
    const data = useCompleted(key, (data = []) => {
      return data.slice(index, lastIndex);
    })

    Parameters

    • key: any
    • callback: (data: any) => any
        • (data: any): any

        • Parameters

          • data: any

          Returns any

    • update: boolean = false

    Returns any

useDataPagination

  • useDataPagination(data: any[], __namedParameters: { current: number; limit: number }): { current: number; data: any[]; length: number; limit: number }

  • Data based paging of massive cache data

    Parameters

    • data: any[]
    • __namedParameters: { current: number; limit: number }
      • current: number
      • limit: number

    Returns { current: number; data: any[]; length: number; limit: number }

    • current: number
    • data: any[]
    • length: number
    • limit: number

useFetchFunction

  • useFetchFunction(func: (options: any) => any, params?: Record<string, any>, options?: Record<string, any>): { data: any; error: any; loading: boolean }

  • use fetch data fucntion as useState, no need to useEffect.

    example

    const { data: markets, error, loading } = useFetchFunction(getMarkets, { symbol, });

    Parameters

    • func: (options: any) => any
        • (options: any): any

        • Parameters

          • options: any

          Returns any

    • Optional params: Record<string, any>
    • Optional options: Record<string, any>

    Returns { data: any; error: any; loading: boolean }

    • data: any
    • error: any
    • loading: boolean

useFilterFromData

  • useFilterFromData(data: any[], filter: Record<string | number | symbol, any>): any

  • Retrieve data from provided data

    Parameters

    • data: any[]
    • filter: Record<string | number | symbol, any>

    Returns any

useFilterFromKey

  • useFilterFromKey(key: any, filter: Record<string | number | symbol, any>): any

  • Retrieve data from the provided key value

    Parameters

    • key: any
    • filter: Record<string | number | symbol, any>

    Returns any

usePagination

  • usePagination(key: any, __namedParameters: { current: number; limit: number }): { current: number; data: any; limit: number }

  • Key based paging of massive cached data

    Parameters

    • key: any
    • __namedParameters: { current: number; limit: number }
      • current: number
      • limit: number

    Returns { current: number; data: any; limit: number }

    • current: number
    • data: any
    • limit: number

useSearch

  • useSearch(keyOrdata: any, filter: Record<string | number | symbol, any>): any

  • Parameters

    • keyOrdata: any
    • filter: Record<string | number | symbol, any>

    Returns any

useStore

  • useStore(key: any, value: any): any

useUpdateCompleted

  • useUpdateCompleted(key: any): any

Generated using TypeDoc