Documents / @faasjs/react / FaasReactClientInstance

Type Alias: FaasReactClientInstance

FaasReactClientInstance = object

Methods

FaasDataWrapper()

FaasDataWrapper<PathOrData>(props): Element

Type Parameters

PathOrData

PathOrData extends FaasActionUnionType

Parameters

props

FaasDataWrapperProps<PathOrData>

Returns

Element

Properties

browserClient

browserClient: FaasBrowserClient

faas()

faas: <PathOrData>(action, params, options?) => Promise<Response<FaasData<PathOrData>>>

Type Parameters

PathOrData

PathOrData extends FaasActionUnionType

Parameters

action

FaasAction<PathOrData>

params

FaasParams<PathOrData>

options?

Options

Returns

Promise<Response<FaasData<PathOrData>>>

id

id: string

onError?

optional onError: OnError

useFaas()

useFaas: <PathOrData>(action, defaultParams, options?) => FaasDataInjection<PathOrData>

Type Parameters

PathOrData

PathOrData extends FaasActionUnionType

Parameters

action

FaasAction<PathOrData>

defaultParams

FaasParams<PathOrData>

options?

useFaasOptions<PathOrData>

Returns

FaasDataInjection<PathOrData>