teraslice-client-js / assets / default

Class: default

Defined in: assets.ts:8

Extends

• default

Constructors

Constructor

new default(config): Assets

Defined in: assets.ts:9

Parameters

Parameter	Type
config	ClientConfig

Returns

Assets

Overrides

default.constructor

Properties

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

Methods

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

---

getAsset()

getAsset(name, version, searchOptions): Promise<AssetRecord[]>

Defined in: assets.ts:54

Parameters

Parameter	Type	Default value
name	string	undefined
version	string	''
searchOptions	RequestOptions	{}

Returns

Promise<AssetRecord[]>

---

list()

list(query, searchOptions): Promise<AssetRecord[]>

Defined in: assets.ts:46

Parameters

Parameter	Type
query	SearchQuery
searchOptions	RequestOptions

Returns

Promise<AssetRecord[]>

---

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

---

remove()

remove(id, searchOptions): Promise<AssetIDResponse>

Defined in: assets.ts:31

Parameters

Parameter	Type
id	string
searchOptions	RequestOptions

Returns

Promise<AssetIDResponse>

---

txt()

txt(name, version, query, searchOptions): Promise<string>

Defined in: assets.ts:75

Parameters

Parameter	Type	Default value
name	string	''
version	string	''
query	TxtSearchParams	{}
searchOptions	RequestOptions	{}

Returns

Promise<string>

---

upload()

upload(data, query): Promise<AssetIDResponse>

Defined in: assets.ts:14

Parameters

Parameter	Type
data	PostData
query	AssetUploadQuery

Returns

Promise<AssetIDResponse>