All files / libs/amalia-lang/formula/evaluate/shared/src/functions/string/lower index.ts

100% Statements 26/26
50% Branches 1/2
100% Functions 1/1
100% Lines 26/26

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 271x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x  
import { AmaliaFunctionCategory, AmaliaFunctionKeys, type AmaliaFormula } from '@amalia/amalia-lang/formula/types';
 
import { AmaliaFunctionDefault } from '../../AmaliaFunction';
 
export const stringLower = new AmaliaFunctionDefault<[(number | string)?], string>({
  name: AmaliaFunctionKeys.LOWER,
  category: AmaliaFunctionCategory.STRING,
  nbParamsRequired: 0,
  description: 'Return the string in lower case',
 
  exec: (stringToLower) => stringToLower?.toString().toLowerCase() ?? '',
 
  params: [{ name: 'string', description: 'String: variables, fields, properties, string' }],
 
  examples: [
    {
      desc: 'Returns hello.',
      formula: 'LOWER("Hello")' as AmaliaFormula,
      result: 'hello',
    },
    {
      desc: "Returns the user's first name in lower case.",
      formula: 'LOWER(user.firstName)',
    },
  ],
});