Function factoryParameters

  • Type Parameters

    • T extends Record<string, unknown>

    • N extends InnerNamespace<T>

    Parameters

    • config: Config
    • defaultInitialValues: InitialValuesProvider<T> = ...
    • ns: string = DEFAULT_NAMESPACE

    Returns {
        createQueryString: ((values, initialValues?) => string);
        parseQueryString: ((query, initialValues?) => Partial<T>);
        useQuery: (() => {
            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?) => string)
        • (values, initialValues?): string
        • Parameters

          • values: PartialDeep<T>
          • Optional initialValues: null | PartialDeep<T>
            Optional

          Returns string

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

          • query: string
          • Optional initialValues: null | PartialDeep<T>
            Optional

          Returns Partial<T>

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

          • 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

    Generated using TypeDoc