Function useSetting

  • useSetting<T, D, K, F>(settings, key, fallback?): {
        onChange: ((newValue: ValType<T[K]>) => void);
        value: K extends D
            ? NonNullable<T[K]>
            : F extends null | undefined
                ? T[K] | undefined
                : NonNullable<T[K]> | F;
    }

  • Type Parameters

    • T extends Record<string, Jsonifiable>
    • D extends string | number | symbol
    • K extends string
    • F extends undefined | Jsonifiable

    Parameters

    Returns {
        onChange: ((newValue: ValType<T[K]>) => void);
        value: K extends D
            ? NonNullable<T[K]>
            : F extends null | undefined
                ? T[K] | undefined
                : NonNullable<T[K]> | F;
    }

    • onChange: ((newValue: ValType<T[K]>) => void)
        • (newValue): void

        • Parameters

          • newValue: ValType<T[K]>

          Returns void

    • value: K extends D
          ? NonNullable<T[K]>
          : F extends null | undefined
              ? T[K] | undefined
              : NonNullable<T[K]> | F

Settings

Member Visibility