rest-vir - v2.2.0
    Preparing search index...

    Type Alias SearchParamsObjectType<Requirements>

    SearchParamsObjectType: {
        [Key in keyof Requirements as IsOptionalSearchParamRequirement<
            Requirements[Key],
        > extends true
            ? never
            : Key]: ExtractSearchParamValue<Requirements[Key]>
    } & {
        [Key in keyof Requirements as IsOptionalSearchParamRequirement<
            Requirements[Key],
        > extends true
            ? Key
            : never]?: ExtractSearchParamValue<Requirements[Key]>
    }

    Builds the params object's TypeScript type from a searchParams requirement record. Splits the keys into required (shape rejects undefined) and optional (shape accepts undefined).

    Type Parameters

    • Requirements extends AnyObject

    @rest-vir/api

    Settings

    Member Visibility