Beignet API reference
    Preparing search index...

    Type Alias TestRequester<TProvidedHeaders>

    Request helpers with default call arguments already applied.

    type TestRequester<TProvidedHeaders extends string = never> = {
        request: <CLike extends ContractLike>(
            contract: CLike,
            ...args: CallArgs<ResolveContract<CLike>, TProvidedHeaders>,
        ) => Promise<InferSuccessResponse<ResolveContract<CLike>>>;
        safeRequest: <CLike extends ContractLike>(
            contract: CLike,
            ...args: CallArgs<ResolveContract<CLike>, TProvidedHeaders>,
        ) => Promise<
            EndpointResult<
                ResolveContract<CLike>,
                InferEndpointContractError<ResolveContract<CLike>>,
            >,
        >;
    }

    Type Parameters

    • TProvidedHeaders extends string = never
    Index
    request: <CLike extends ContractLike>(
        contract: CLike,
        ...args: CallArgs<ResolveContract<CLike>, TProvidedHeaders>,
    ) => Promise<InferSuccessResponse<ResolveContract<CLike>>>

    Call a contract through the test app using default request values.

    safeRequest: <CLike extends ContractLike>(
        contract: CLike,
        ...args: CallArgs<ResolveContract<CLike>, TProvidedHeaders>,
    ) => Promise<
        EndpointResult<
            ResolveContract<CLike>,
            InferEndpointContractError<ResolveContract<CLike>>,
        >,
    >

    Call a contract through the test app using default request values and return a typed success/error result instead of throwing.