Class ConnectionsFileReader

Helper for reading a connections JSON file.

Hierarchy

ConnectionsFileReader

Index

Methods

Methods

getConnectionsFilePath

getConnectionsFilePath(connFile: string): string

- Defined in connection/connections-file-reader.ts:14
Get the absolute path to a connections.json file. If the path provided is not absolute then it's assumed relative to the current working directory.

Parameters
- connFile: string
  
  Absolute or relative path to a connections file.
Returns string

readConnectionOptions

readConnectionOptions(connFile: string): ConnectionOptions[]

- Defined in connection/connections-file-reader.ts:29
Get (and verify) the connection options in a file. The file should contain an array of ConnectionOptions. Alternatively, ConnectionOptions keys in the file may be objects in the form {ENV: "<ENV_VAR_NAME>"}, which allows for the use of environment variables.

Parameters
- connFile: string
  
  A path to a connections.json file containing an array of connection details.
Returns ConnectionOptions[]

An array of ConnectionOptions objects.

Generated using TypeDoc