teraslice-client-js / cluster / default

Class: default

Defined in: cluster.ts:12

Extends

• default

Constructors

Constructor

new default(config): Cluster

Defined in: cluster.ts:13

Parameters

Parameter	Type
config	Record<string, any>

Returns

Cluster

Overrides

default.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
_config	readonly	ClientConfig	default._config	client.ts:14

Methods

controllers()

controllers(): Promise<ExecutionList>

Defined in: cluster.ts:35

Returns

Promise<ExecutionList>

---

delete()

delete<T>(endpoint, options?): Promise<T>

Defined in: client.ts:54

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
endpoint	string
options?	Partial<Options>

Returns

Promise<T>

Inherited from

default.delete

---

get()

get<T>(endpoint, options?): Promise<T>

Defined in: client.ts:42

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
endpoint	string
options?	Partial<Options>

Returns

Promise<T>

Inherited from

default.get

---

info()

info(): Promise<ApiRootResponse>

Defined in: cluster.ts:19

Returns

Promise<ApiRootResponse>

---

makeOptions()

protected makeOptions(searchParams, options): RequestOptions

Defined in: client.ts:110

Parameters

Parameter	Type
searchParams	undefined | Record<string, any>
options	RequestOptions

Returns

RequestOptions

Inherited from

default.makeOptions

---

parse()

protected parse(results): any

Defined in: client.ts:106

Parameters

Parameter	Type
results	unknown

Returns

any

Inherited from

default.parse

---

post()

post<T>(endpoint, data?, options?): Promise<T>

Defined in: client.ts:46

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
endpoint	string
data?	unknown
options?	Partial<Options>

Returns

Promise<T>

Inherited from

default.post

---

put()

put<T>(endpoint, data, options?): Promise<T>

Defined in: client.ts:50

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
endpoint	string
data	unknown
options?	Partial<Options>

Returns

Promise<T>

Inherited from

default.put

---

slicers()

slicers(): Promise<ExecutionList>

Defined in: cluster.ts:31

Returns

Promise<ExecutionList>

---

state()

state(): Promise<ClusterState>

Defined in: cluster.ts:23

Returns

Promise<ClusterState>

---

stats()

stats(): Promise<ClusterStats>

Defined in: cluster.ts:27

Returns

Promise<ClusterStats>

---

txt()

txt(type): Promise<string>

Defined in: cluster.ts:39

Parameters

Parameter	Type
type	string

Returns

Promise<string>