Function factoryParameters

Returns {
    createQueryString: ((values, initialValues?, context?) => string);
    parseQueryString: ((query, initialValues?, context?) => Partial<T>);
    useQuery: (() => {
        context: undefined | C;
        createQuery: ((customValues?) => {});
        createQueryString: ((customValues?) => string);
        initialValues: T;
        pushState: ((state, options?) => Promise<unknown>);
        replaceState: ((state, options?) => Promise<unknown>);
        resetPush: (() => void);
        resetReplace: (() => void);
        values: T;
    });
}

• createQueryString: ((values, initialValues?, context?) => string)

  • • (values, initialValues?, context?): string

    • Parameters

      • values: PartialDeep<T>

      • Optional initialValues: null | PartialDeep<T>

        Optional

      • Optional context: C

        Optional

      Returns string

• parseQueryString: ((query, initialValues?, context?) => Partial<T>)

  • • (query, initialValues?, context?): Partial<T>

    • Parameters

      • query: string

      • Optional initialValues: null | PartialDeep<T>

        Optional

      • Optional context: C

        Optional

      Returns Partial<T>

• useQuery: (() => {
      context: undefined | C;
      createQuery: ((customValues?) => {});
      createQueryString: ((customValues?) => string);
      initialValues: T;
      pushState: ((state, options?) => Promise<unknown>);
      replaceState: ((state, options?) => Promise<unknown>);
      resetPush: (() => void);
      resetReplace: (() => void);
      values: T;
  })

  • • (): {
          context: undefined | C;
          createQuery: ((customValues?) => {});
          createQueryString: ((customValues?) => string);
          initialValues: T;
          pushState: ((state, options?) => Promise<unknown>);
          replaceState: ((state, options?) => Promise<unknown>);
          resetPush: (() => void);
          resetReplace: (() => void);
          values: T;
      }

    • Returns {
          context: undefined | C;
          createQuery: ((customValues?) => {});
          createQueryString: ((customValues?) => string);
          initialValues: T;
          pushState: ((state, options?) => Promise<unknown>);
          replaceState: ((state, options?) => Promise<unknown>);
          resetPush: (() => void);
          resetReplace: (() => void);
          values: T;
      }

      • context: undefined | C

      • createQuery: ((customValues?) => {})

        • • (customValues?): {}

          • Parameters

            • Optional customValues: PartialDeep<T>

              Optional

            Returns {}

      • createQueryString: ((customValues?) => string)

        • • (customValues?): string

          • Parameters

            • Optional customValues: PartialDeep<T>

              Optional

            Returns string

      • initialValues: T

      • pushState: ((state, options?) => Promise<unknown>)

        • • (state, options?): Promise<unknown>

          • Parameters

            • state: ((state) => void)

              • • (state): void

                • Parameters

                  • state: T

                  Returns void

            • Optional options: Record<string, unknown>

              Optional

            Returns Promise<unknown>

      • replaceState: ((state, options?) => Promise<unknown>)

        • • (state, options?): Promise<unknown>

          • Parameters

            • state: ((state) => void)

              • • (state): void

                • Parameters

                  • state: T

                  Returns void

            • Optional options: Record<string, unknown>

              Optional

            Returns Promise<unknown>

      • resetPush: (() => void)

        • • (): void

          • Returns void

      • resetReplace: (() => void)

        • • (): void

          • Returns void

      • values: T