jsforce
Preparing search index...
registry/types
Registry
Type Alias Registry
type
Registry
=
{
getClientConfig
(
name
:
string
)
:
Promise
<
ClientConfig
|
null
>
;
getClientNames
()
:
Promise
<
string
[]
>
;
getConnection
<
S
extends
Schema
=
Schema
>
(
name
?:
string
,
)
:
Promise
<
Connection
<
S
>
|
null
>
;
getConnectionConfig
(
name
?:
string
)
:
Promise
<
ConnectionConfig
|
null
>
;
getConnectionNames
()
:
Promise
<
string
[]
>
;
registerClientConfig
(
name
:
string
,
clientConfig
:
ClientConfig
,
)
:
Promise
<
void
>
;
removeConnectionConfig
(
name
:
string
)
:
Promise
<
void
>
;
saveConnectionConfig
(
name
:
string
,
connConfig
:
ConnectionConfig
,
)
:
Promise
<
void
>
;
setDefaultConnection
(
name
:
string
)
:
Promise
<
void
>
;
}
Implemented by
BaseRegistry
SfdxRegistry
Index
Methods
get
Client
Config
get
Client
Names
get
Connection
get
Connection
Config
get
Connection
Names
register
Client
Config
remove
Connection
Config
save
Connection
Config
set
Default
Connection
Methods
get
Client
Config
getClientConfig
(
name
:
string
)
:
Promise
<
ClientConfig
|
null
>
Parameters
name
:
string
Returns
Promise
<
ClientConfig
|
null
>
get
Client
Names
getClientNames
()
:
Promise
<
string
[]
>
Returns
Promise
<
string
[]
>
get
Connection
getConnection
<
S
extends
Schema
=
Schema
>
(
name
?:
string
,
)
:
Promise
<
Connection
<
S
>
|
null
>
Type Parameters
S
extends
Schema
=
Schema
Parameters
Optional
name
:
string
Returns
Promise
<
Connection
<
S
>
|
null
>
get
Connection
Config
getConnectionConfig
(
name
?:
string
)
:
Promise
<
ConnectionConfig
|
null
>
Parameters
Optional
name
:
string
Returns
Promise
<
ConnectionConfig
|
null
>
get
Connection
Names
getConnectionNames
()
:
Promise
<
string
[]
>
Returns
Promise
<
string
[]
>
register
Client
Config
registerClientConfig
(
name
:
string
,
clientConfig
:
ClientConfig
)
:
Promise
<
void
>
Parameters
name
:
string
clientConfig
:
ClientConfig
Returns
Promise
<
void
>
remove
Connection
Config
removeConnectionConfig
(
name
:
string
)
:
Promise
<
void
>
Parameters
name
:
string
Returns
Promise
<
void
>
save
Connection
Config
saveConnectionConfig
(
name
:
string
,
connConfig
:
ConnectionConfig
)
:
Promise
<
void
>
Parameters
name
:
string
connConfig
:
ConnectionConfig
Returns
Promise
<
void
>
set
Default
Connection
setDefaultConnection
(
name
:
string
)
:
Promise
<
void
>
Parameters
name
:
string
Returns
Promise
<
void
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
get
Client
Config
get
Client
Names
get
Connection
get
Connection
Config
get
Connection
Names
register
Client
Config
remove
Connection
Config
save
Connection
Config
set
Default
Connection
jsforce
Loading...