@reactor/sites — sitesclient
@reactor/sites / SitesClient
Class: SitesClient
Section titled “Class: SitesClient”Defined in: index.ts:36
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SitesClient(
ctx):SitesClient
Defined in: index.ts:37
Parameters
Section titled “Parameters”RequestContext
Returns
Section titled “Returns”SitesClient
Accessors
Section titled “Accessors”deployments
Section titled “deployments”Get Signature
Section titled “Get Signature”get deployments():
object
Defined in: index.ts:73
Deployment management
Returns
Section titled “Returns”object
get: (
siteName,deploymentId) =>Promise<Result<Deployment>>
Parameters
Section titled “Parameters”siteName
Section titled “siteName”string
deploymentId
Section titled “deploymentId”string
Returns
Section titled “Returns”Promise<Result<Deployment>>
list: (
siteName,options?) =>Promise<Result<Deployment[]>>
Parameters
Section titled “Parameters”siteName
Section titled “siteName”string
options?
Section titled “options?”limit?
Section titled “limit?”number
Returns
Section titled “Returns”Promise<Result<Deployment[]>>
promote
Section titled “promote”promote: (
siteName,deploymentId) =>Promise<Result<Deployment>>
Parameters
Section titled “Parameters”siteName
Section titled “siteName”string
deploymentId
Section titled “deploymentId”string
Returns
Section titled “Returns”Promise<Result<Deployment>>
rollback
Section titled “rollback”rollback: (
siteName,deploymentId) =>Promise<Result<Deployment>>
Parameters
Section titled “Parameters”siteName
Section titled “siteName”string
deploymentId
Section titled “deploymentId”string
Returns
Section titled “Returns”Promise<Result<Deployment>>
domains
Section titled “domains”Get Signature
Section titled “Get Signature”get domains():
object
Defined in: index.ts:59
Domain management
Returns
Section titled “Returns”object
add: (
siteName,domain) =>Promise<Result<Domain>>
Parameters
Section titled “Parameters”siteName
Section titled “siteName”string
domain
Section titled “domain”string
Returns
Section titled “Returns”Promise<Result<Domain>>
list: (
siteName) =>Promise<Result<Domain[]>>
Parameters
Section titled “Parameters”siteName
Section titled “siteName”string
Returns
Section titled “Returns”Promise<Result<Domain[]>>
remove
Section titled “remove”remove: (
siteName,domain) =>Promise<Result<void>>
Parameters
Section titled “Parameters”siteName
Section titled “siteName”string
domain
Section titled “domain”string
Returns
Section titled “Returns”Promise<Result<void>>
Methods
Section titled “Methods”delete()
Section titled “delete()”delete(
siteName):Promise<Result<void>>
Defined in: index.ts:102
Delete a site
Parameters
Section titled “Parameters”siteName
Section titled “siteName”string
Returns
Section titled “Returns”Promise<Result<void>>
deploy()
Section titled “deploy()”deploy(
siteName,bundle,options?):Promise<Result<Deployment>>
Defined in: index.ts:42
Deploy a site bundle.
Parameters
Section titled “Parameters”siteName
Section titled “siteName”string
bundle
Section titled “bundle”Blob | ArrayBuffer
options?
Section titled “options?”framework?
Section titled “framework?”string
Returns
Section titled “Returns”Promise<Result<Deployment>>
get(
siteName):Promise<Result<Site>>
Defined in: index.ts:97
Get site info
Parameters
Section titled “Parameters”siteName
Section titled “siteName”string
Returns
Section titled “Returns”Promise<Result<Site>>
list()
Section titled “list()”list():
Promise<Result<Site[]>>
Defined in: index.ts:92
List all sites
Returns
Section titled “Returns”Promise<Result<Site[]>>