Class SfdxRegistry

constructor

• new SfdxRegistry(__namedParameters): SfdxRegistry

• Parameters

  • __namedParameters: {
        cliPath?: string;
    }

    • Optional cliPath?: string

  Returns SfdxRegistry

_cliPath

_defaultOrgInfo

_orgInfoMap

_orgList

_createCommand

• _createCommand(command, options?, args?): string

• Parameters

  • command: string
  • options: {
        [option: string]: any;
    } = {}

    • [option: string]: any

  • args: string[] = []

  Returns string

_execCommand

• _execCommand<T>(command, options?, args?): Promise<T>

• Type Parameters

  • T

  Parameters

  • command: string
  • options: {
        [option: string]: any;
    } = {}

    • [option: string]: any

  • args: string[] = []

  Returns Promise<T>

_getOrgInfo

• _getOrgInfo(username?): Promise<SfdxOrgInfo>

• Parameters

  • Optional username: string

  Returns Promise<SfdxOrgInfo>

_getOrgList

• _getOrgList(): Promise<SfdxOrgList>

• Returns Promise<SfdxOrgList>

_memoOrgInfo

• _memoOrgInfo(pOrgInfo, username?): void

• Parameters

  • pOrgInfo: Promise<SfdxOrgInfo>
  • Optional username: string

  Returns void

getClientConfig

• getClientConfig(_name): Promise<null>

• Parameters

  • _name: string

  Returns Promise<null>

getClientNames

• getClientNames(): Promise<never[]>

• Returns Promise<never[]>

getConnection

• getConnection<S>(name?): Promise<null | Connection<S>>

• Type Parameters

  • S extends Schema = Schema

  Parameters

  • Optional name: string

  Returns Promise<null | Connection<S>>

getConnectionConfig

• getConnectionConfig(name?): Promise<null | {
      accessToken: string;
      instanceUrl: string;
      loginUrl: string;
  }>

• Parameters

  • Optional name: string

  Returns Promise<null | {
      accessToken: string;
      instanceUrl: string;
      loginUrl: string;
  }>

getConnectionNames

• getConnectionNames(): Promise<string[]>

• Returns Promise<string[]>

registerClientConfig

• registerClientConfig(_name, _clientConfig): Promise<void>

• Parameters

  • _name: string
  • _clientConfig: ClientConfig

  Returns Promise<void>

removeConnectionConfig

• removeConnectionConfig(name): Promise<void>

• Parameters

  • name: string

  Returns Promise<void>

saveConnectionConfig

• saveConnectionConfig(_name, _connConfig): Promise<void>

• Parameters

  • _name: string
  • _connConfig: ConnectionConfig

  Returns Promise<void>

setDefaultConnection

• setDefaultConnection(_name): Promise<void>

• Parameters

  • _name: string

  Returns Promise<void>