Options
All
  • Public
  • Public/Protected
  • All
Menu

@apiglobal/typedrequest

Index

Type Aliases

IPostMethod: ((typedRequestPostObject: plugins.typedRequestInterfaces.ITypedRequest) => Promise<plugins.typedRequestInterfaces.ITypedRequest>)

Type declaration

    • (typedRequestPostObject: plugins.typedRequestInterfaces.ITypedRequest): Promise<plugins.typedRequestInterfaces.ITypedRequest>
    • Parameters

      • typedRequestPostObject: plugins.typedRequestInterfaces.ITypedRequest

      Returns Promise<plugins.typedRequestInterfaces.ITypedRequest>

IPostMethodWithTypedRouter: ((typedRequestPostObject: plugins.typedRequestInterfaces.ITypedRequest) => Promise<void> | Promise<plugins.typedRequestInterfaces.ITypedRequest>)

Type declaration

    • (typedRequestPostObject: plugins.typedRequestInterfaces.ITypedRequest): Promise<void> | Promise<plugins.typedRequestInterfaces.ITypedRequest>
    • this is an alternative to a post url supplied in new Typedrequest(new TypedTarget(...), 'someMethodName') enables the use of custom post functions used for things like broadcast channels e.g. @designestate/dees-comms the main difference here is, that the response comes back async and is routed by interest through typedrouter

      Parameters

      • typedRequestPostObject: plugins.typedRequestInterfaces.ITypedRequest

      Returns Promise<void> | Promise<plugins.typedRequestInterfaces.ITypedRequest>

THandlerFunction<T>: ((requestArg: T["request"]) => Promise<T["response"]>)

Type Parameters

  • T extends plugins.typedRequestInterfaces.ITypedRequest

Type declaration

    • (requestArg: T["request"]): Promise<T["response"]>
    • Parameters

      • requestArg: T["request"]

      Returns Promise<T["response"]>

Generated using TypeDoc