Class SfdxRegistry

constructor

• new SfdxRegistry(__namedParameters: { cliPath?: string }): SfdxRegistry

  Parameters

  • __namedParameters: { cliPath?: string }

  Returns SfdxRegistry

_cliPath

_defaultOrgInfo

_orgInfoMap

_orgList

_buildArgs

• _buildArgs(
      command: string,
      options?: { [option: string]: any },
      args?: string[],
  ): { argv: string[]; exe: string }

  Parameters

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

  Returns { argv: string[]; exe: string }

_execCommand

• _execCommand<T>(
      command: string,
      options?: { [option: string]: any },
      args?: string[],
  ): Promise<T>

  Type Parameters

  • T

  Parameters

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

  Returns Promise<T>

_getOrgInfo

• _getOrgInfo(username?: string): Promise<SfdxOrgInfo>

  Parameters

  • Optionalusername: string

  Returns Promise<SfdxOrgInfo>

_getOrgList

• _getOrgList(): Promise<SfdxOrgList>

  Returns Promise<SfdxOrgList>

_memoOrgInfo

• _memoOrgInfo(pOrgInfo: Promise<SfdxOrgInfo>, username?: string): void

  Parameters

  • pOrgInfo: Promise<SfdxOrgInfo>
  • Optionalusername: string

  Returns void

getClientConfig

• getClientConfig(_name: string): Promise<null>

  Parameters

  • _name: string

  Returns Promise<null>

getClientNames

• getClientNames(): Promise<never[]>

  Returns Promise<never[]>

getConnection

• getConnection<S extends Schema = Schema>(
      name?: string,
  ): Promise<Connection<S> | null>

  Type Parameters

  • S extends Schema = Schema

  Parameters

  • Optionalname: string

  Returns Promise<Connection<S> | null>

getConnectionConfig

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

  Parameters

  • Optionalname: string

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

getConnectionNames

• getConnectionNames(): Promise<string[]>

  Returns Promise<string[]>

registerClientConfig

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

  Parameters

  • _name: string
  • _clientConfig: ClientConfig

  Returns Promise<void>

removeConnectionConfig

• removeConnectionConfig(name: string): Promise<void>

  Parameters

  • name: string

  Returns Promise<void>

saveConnectionConfig

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

  Parameters

  • _name: string
  • _connConfig: ConnectionConfig

  Returns Promise<void>

setDefaultConnection

• setDefaultConnection(_name: string): Promise<void>

  Parameters

  • _name: string

  Returns Promise<void>