Beignet API reference
    Preparing search index...

    Class NuqsQueryHelper<TContract, TParsers>

    URL-state helper bound to one contract query schema.

    Type Parameters

    Index

    Constructors

    constructor

    Accessors

    contractName

    Methods

    toQuery toQueryOptions useState

    Constructors

    • Type Parameters

      • TContract extends HttpContractConfig
      • TParsers extends Partial<
            {
                [K in string]: {
                    [Key in string]: KeyMapValue<
                        { [P in string]: Exclude<QueryRecord<(...)>[P], undefined> }[Key],
                    >
                }[K]
            },
        > & { [key: string]: KeyMapValue<any> }

      Parameters

      Returns NuqsQueryHelper<TContract, TParsers>

    Accessors

    • get contractName(): string

      Fully qualified contract name.

      Returns string

    Methods

    • Convert Nuqs state into Beignet endpoint query args.

      Nullish values are omitted by default to keep generated query strings clean.

      Parameters

      • state: inferParserType<TParsers>
      • opts: { omitNullish?: boolean } = {}

      Returns EndpointCallArgs<TContract>["query"]

    • Bind contract query params to URL state through Nuqs.

      Parameters

      • options: ContractQueryHookOptions<TParsers> = {}

      Returns UseQueryStatesReturn<TParsers>

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods