Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace global

Index

Functions

Functions

activate

  • activate(filename: any, forceEmptyEdit: any): { address: string; args: ({ type: string; value: string } | { type: string; value: number })[] }

  • Select an session file, loading it if it exists.

    Parameters

    • filename: any

      the edit filename to activate

    • forceEmptyEdit: any

    Returns { address: string; args: ({ type: string; value: string } | { type: string; value: number })[] }

    • address: string
    • args: ({ type: string; value: string } | { type: string; value: number })[]

cd

  • cd(path: any): { address: string; args: { type: string; value: string } }

  • Request that the server change its working directory.

    Parameters

    • path: any

      target working directory

    Returns { address: string; args: { type: string; value: string } }

    • address: string
    • args: { type: string; value: string }
      • type: string
      • value: string

requestRenderedWavFile

  • requestRenderedWavFile(): { address: string }

  • Ask cybr to render a file, and return the result. This is an experimental feature available in cybr 0.3.2.

    Returns { address: string }

    • address: string

save

  • save(filename?: string, samplePathMode?: string): { address: string; args: { type: string; value: string }[] }

  • Parameters

    • Optional filename: string
    • Optional samplePathMode: string

    Returns { address: string; args: { type: string; value: string }[] }

    • address: string
    • args: { type: string; value: string }[]

version

  • version(semverPatternOrHandler?: string | ((error: number, cybrVersion: string) => any)): any

  • Get semantic version number of the cybr server.

    Parameters

    • Optional semverPatternOrHandler: string | ((error: number, cybrVersion: string) => any)

      if this is a string, treat it as a semver pattern, and print a warning if the value returned by the server does not satisfy this argument. This can also be a handler function, which accepts an error integer as the first argument and a semver string as the second. If no argument is provided, print a message stating the cybr version.

    Returns any