Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Library

Hierarchy

  • Library

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Library(pathToFile: string): Library

Properties

created

created: object

members

members: Member[]

modified

modified: object

osVersion

osVersion: string

pathToFile

pathToFile: string

sasVersion

sasVersion: string

Methods

getData

  • getData(options?: Options): Promise<Array<Array<number | string> | object>>

  • Get all observations. This method will load all records into memory, for large datasets, the read method is suggested.

    Parameters

    • Optional options: Options

      Read options. See read method options for details

    Returns Promise<Array<Array<number | string> | object>>

getMetadata

  • getMetadata(): Promise<object>

read

  • read(options?: Options): AsyncIterable<Array<number | string> | object>

  • Read observations as async iterable.

    Parameters

    • Optional options: Options

      Read options.

      • dsNames List of dataset names to read, by default all datasets are read.
      • rowFormat [default=array] Output observation format.
        array: [value1, value2, value3, ...]
        object: { var1: value1, var: value2, var3: value3, ... }
      • keep [default=[]] Array of variables to keep in the result (case-insensitive)
      • skipHeader [default=false] Flag to control whether the first record contains variable names.
      • encoding [default=binary] String encoding, default is latin1 (binary). See the list of encodings supported by Node.js.

    Returns AsyncIterable<Array<number | string> | object>

toCsv

  • toCsv(outDir: string, options?: Options): Promise<void>

  • Convert XPT to CSV files. Each dataset within the XPT file is written to the outDir folder as a separate csv file.

    Parameters

    • outDir: string

      Output folder.

    • Optional options: Options

      Read options. See read() method options.

    Returns Promise<void>

Generated using TypeDoc