Options
All
  • Public
  • Public/Protected
  • All
Menu

solid-cached-resource

Index

Functions

  • createCachedResource<T, S>(source: ResourceSource<S>, fetcher: ResourceFetcher<S, T>, options?: CachedResourceOptions<T>): ResourceReturn<undefined | T>
  • Type parameters

    • T

    • S = any

    Parameters

    Returns ResourceReturn<undefined | T>

  • createMutation<T, R>(fn: (input?: T) => Promise<R>, options?: CreateMutationOptions<R>): { error: Accessor<any>; isError: () => boolean; isLoading: Accessor<boolean>; isSuccess: Accessor<boolean>; mutateAsync: (input?: T) => Promise<undefined | R>; reset: () => void; returnedData: Accessor<undefined | R> }
  • Type parameters

    • T

    • R = any

    Parameters

    • fn: (input?: T) => Promise<R>
        • (input?: T): Promise<R>
        • Parameters

          • Optional input: T

          Returns Promise<R>

    • Optional options: CreateMutationOptions<R>

    Returns { error: Accessor<any>; isError: () => boolean; isLoading: Accessor<boolean>; isSuccess: Accessor<boolean>; mutateAsync: (input?: T) => Promise<undefined | R>; reset: () => void; returnedData: Accessor<undefined | R> }

    • error: Accessor<any>
    • isError: () => boolean
        • (): boolean
        • Returns boolean

    • isLoading: Accessor<boolean>
    • isSuccess: Accessor<boolean>
    • mutateAsync: (input?: T) => Promise<undefined | R>
        • (input?: T): Promise<undefined | R>
        • Parameters

          • Optional input: T

          Returns Promise<undefined | R>

    • reset: () => void
        • (): void
        • Returns void

    • returnedData: Accessor<undefined | R>
  • mutateCachedValue<S, T>(source: S, value: T | ((prev: T) => T)): void
  • Type parameters

    • S

    • T = any

    Parameters

    • source: S
    • value: T | ((prev: T) => T)

    Returns void

Generated using TypeDoc