Beignet API reference
    Preparing search index...

    Type Alias EndpointCallArgs<TContract, TProvidedHeaders>

    EndpointCallArgs: PathArgs<TContract> & QueryArgs<TContract> & BodyArgs<
        TContract,
    > & {
        rawBody?: TContract["method"] extends BodyHttpMethod ? BodyInit : never;
        signal?: AbortSignal;
    } & HeadersArgs<TContract, TProvidedHeaders>

    Arguments accepted by an endpoint call for a specific contract.

    Type Parameters

    Type Declaration

    • OptionalrawBody?: TContract["method"] extends BodyHttpMethod ? BodyInit : never

      Escape hatch for non-JSON request bodies such as FormData, Blob, ArrayBuffer, ReadableStream, or pre-serialized text.

      Use body for contract-validated JSON requests. rawBody is sent as-is and is not validated or JSON-serialized.

    • Optionalsignal?: AbortSignal

      Abort signal passed to fetch.