Class API

The API class is derived from CLI it serves the same purpose as the CLI class, but it can not load files, it can only read the given multiline expression

Hierarchy

  • CLI

    Hierarchy

    • API

Constructors

Properties

attributes: attributeConfig

The current line's attribute config

expression: string

The current line's raw expression

globalProfile: undefined | string

The global profile if specified, Will force every expression to adopt this profile

heap: Heap

The program's Heap instance

includeLineNb: number

Total lines of included files

noprint: boolean

Whether to print the tables or not

options: Map<option>

The parsed cli options

path: undefined | string

The path of the running file

profile: string

The current line's profile

tree: TreeNode

The root TreeNode of the current Line

DEFAULT_ATTRIBUTE_CONFIG: attributeConfig = ...
FALSE_ATTRIBUTE_CONFIG: attributeConfig = ...

Methods

  • Parameters

    • line: string

    Returns { line: string; skip: boolean }

    • line: string
    • skip: boolean
  • Parameters

    • isDef: boolean
    • currentLine: number

    Returns string

  • Parameters

    • fileLine: string
    • preparsedLine: string
    • currentLine: number
    • rawLineNb: number

    Returns boolean

  • Parameters

    • Optional filename: string

    Returns string

  • Parameters

    • totalLines: number
    • rawFileLength: number

    Returns void

  • Parameters

    • expression: string
    • values: string
    • profile: string

    Returns string

Generated using TypeDoc