Class NuqsContractHelper<TContract>

Nuqs helper bound to one contract.

Type Parameters

TContract extends HttpContractConfig

Index

Constructors

Methods

Constructors

constructor

new NuqsContractHelper<TContract extends HttpContractConfig>(
contract: TContract,
): NuqsContractHelper<TContract>
Type Parameters
- TContract extends HttpContractConfig
Parameters
- contract: TContract
Returns NuqsContractHelper<TContract>
- Defined in packages/nuqs/src/index.ts:168

Methods

query

query<
    TParsers extends
        Partial<
            {
                [K in string]: {
                    [Key in string]: KeyMapValue<
                        { [P in string]: Exclude<QueryRecord<(...)>[P], undefined> }[Key],
                    >
                }[K]
            },
        > & { [key: string]: KeyMapValue<any> },
>(
    config: ContractQueryConfig<TContract, TParsers>,
): NuqsQueryHelper<TContract, TParsers>
Create a URL-state query helper for this contract.

The contract must declare a query schema so parser keys can be checked against the contract query shape.
Type Parameters
- TParsers extends Partial<
      {
          [K in string]: {
              [Key in string]: KeyMapValue<
                  { [P in string]: Exclude<QueryRecord<(...)>[P], undefined> }[Key],
              >
          }[K]
      },
  > & { [key: string]: KeyMapValue<any> }
Parameters
- config: ContractQueryConfig<TContract, TParsers>
Returns NuqsQueryHelper<TContract, TParsers>
- Defined in packages/nuqs/src/index.ts:176