AGGridUtils: {
    parsers: {
        number: ((params) => null | number);
        string: ((params) => null | string);
    };
    setters: {
        numberCeil: ((field) => ((params) => boolean));
        numberFloor: ((field) => ((params) => boolean));
        numberFloat: ((field) => ((params) => boolean));
    };
} = ...

Collection of utility functions for AG Grid integration

Type declaration

  • parsers: {
        number: ((params) => null | number);
        string: ((params) => null | string);
    }

    Collection of value parsers for AG Grid

    • number: ((params) => null | number)

      Parses a string value to a number

      Returns

      Parsed number or null if invalid

      Example

      const value = AGGridUtils.parsers.number({ newValue: '123.45' });
      // Returns: 123.45
        • (params): null | number
        • Parameters

          • params: {
                newValue: string;
            }

            Object containing the new value to parse

            • newValue: string

          Returns null | number

    • string: ((params) => null | string)

      Trims a string value

      Returns

      Trimmed string or null if empty

      Example

      const value = AGGridUtils.parsers.string({ newValue: '  hello  ' });
      // Returns: 'hello'
        • (params): null | string
        • Parameters

          • params: {
                newValue: string;
            }

            Object containing the new value to trim

            • newValue: string

          Returns null | string

  • setters: {
        numberCeil: ((field) => ((params) => boolean));
        numberFloor: ((field) => ((params) => boolean));
        numberFloat: ((field) => ((params) => boolean));
    }

    Collection of value setters for AG Grid

    • numberCeil: ((field) => ((params) => boolean))

      Creates a setter that rounds numbers up to the nearest integer

      Returns

      A value setter function

      Example

      const setter = AGGridUtils.setters.numberCeil('price');
      setter({ data: {}, newValue: 123.45 });
      // Sets data.price to 124
        • (field): ((params) => boolean)
        • Parameters

          • field: string

            The field name to set the value on

          Returns ((params) => boolean)

            • (params): boolean
            • Parameters

              • params: ValueSetterParams<any, any>

              Returns boolean

    • numberFloor: ((field) => ((params) => boolean))

      Creates a setter that rounds numbers down to the nearest integer

      Returns

      A value setter function

      Example

      const setter = AGGridUtils.setters.numberFloor('price');
      setter({ data: {}, newValue: 123.45 });
      // Sets data.price to 123
        • (field): ((params) => boolean)
        • Parameters

          • field: string

            The field name to set the value on

          Returns ((params) => boolean)

            • (params): boolean
            • Parameters

              • params: ValueSetterParams<any, any>

              Returns boolean

    • numberFloat: ((field) => ((params) => boolean))

      Creates a setter that formats numbers to one decimal place if they're integers

      Returns

      A value setter function

      Example

      const setter = AGGridUtils.setters.numberFloat('price');
      setter({ data: {}, newValue: 123 });
      // Sets data.price to '123.0'
        • (field): ((params) => boolean)
        • Parameters

          • field: string

            The field name to set the value on

          Returns ((params) => boolean)

            • (params): boolean
            • Parameters

              • params: ValueSetterParams<any, any>

              Returns boolean