Function hasMacros

  • hasMacros(state?, key?, on?, macros?): null | string

  • Whether handling macros here; or the result of a given hook to handle it.

    Allows macros of the given key to be handled by external named hooks, to replace any part of the functionality here in overall or granular ways.

    The macro names checked in this module are found in hooks.

    Parameters

    • Optionalstate: any

      Any object whose properties may handle macros.

    • Optionalkey: string

      Any name to check granularly within macros. See hooks.

    • Optionalon: string = ''

      Any further macro name specifier; if given, key itself and with this specifier are checked (i.e: key then key+'_'+on).

    • Optionalmacros:
          | string
          | false
          | {}
          | ((...: any[]) => null | string) = state.macros

      How macros should be handled, according to their type, in order of precedence:

      • nullish: macros to be handled here, nullish returned.
      • true: macros to be handled here, nullish returned.
      • falsey: no macros to be handled here, empty '' string returned.
      • string: no macros to be handled here, this hook value's used instead.
      • function: external hasMacros-like function hook, called with macros(state, key, on, macros), the returned value used as shown here.
      • object: recurses with any value at the given key, with hasMacros(state, key, on, macros[key]).
      • Otherwise, macros to be handled here, nullish returned.

    Returns null | string

    Either the result of the macros handled elsewhere, or nullish if macros should be handled here.

    Example: ```javascript // Macros to be handled here, the default. hasMacros() == null; hasMacros({}) == null; hasMacros({ macros: true }) == null; // Macros to be handled here, with prefix `'pre_'` instead of `'preDef'`. hasMacros({ pre: 'pre_' }) == null; // Macros not created. hasMacros({ macros: false }) === ''; hasMacros({ macros: 0 }) === ''; // Macros for `'a'` handled by external `string` hook, not here. hasMacros({ macros: { a: '//A\n', b: () => '//B\n' } }, 'a') === '//A\n'; // Macros for `'b'` handled by external `function` hook, not here. hasMacros({ macros: { a: '//A\n', b: () => '//B\n' } }, 'b') === '//B\n'; // Macros specified `on` a `'frag'` not created. hasMacros({ macros: { frag: 0, values_vert: 0 } }, '', 'frag') === ''; // Macros specified `on` a `'vert'` handled here. hasMacros({ macros: { frag: 0, values_vert: 0 } }, '', 'vert') == null; // Macros of `'values'`/`hooks.values` handled here. hasMacros({ macros: { frag: 0, values_vert: 0 } }, 'values', '') == null; // Macros of `'values'`/`hooks.values` specified `on` a `'vert'` not created. hasMacros({ macros: { frag: 0, values_vert: 0 } }, 'values', 'vert') === ''; ```

    See

    hooks

Settings

Member Visibility