teraslice-client-js / assets / default
Class: default
Defined in: assets.ts:8
Extends
Constructors
new default()
new default(
config
):default
Defined in: assets.ts:9
Parameters
Parameter | Type |
---|---|
config | ClientConfig |
Returns
Overrides
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
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
getAsset()
getAsset(
name
,version
,searchOptions
):Promise
<AssetRecord
[]>
Defined in: assets.ts:54
Parameters
Parameter | Type | Default value |
---|---|---|
name | string | undefined |
version | string | '' |
searchOptions | Partial | {} |
Returns
Promise
<AssetRecord
[]>
list()
list(
query
,searchOptions
):Promise
<AssetRecord
[]>
Defined in: assets.ts:46
Parameters
Parameter | Type |
---|---|
query | SearchQuery |
searchOptions | Partial |
Returns
Promise
<AssetRecord
[]>
makeOptions()
protected
makeOptions(searchParams
,options
):Partial
Defined in: client.ts:110
Parameters
Parameter | Type |
---|---|
searchParams | undefined | Record <string , any > |
options | Partial |
Returns
Partial
Inherited from
parse()
protected
parse(results
):any
Defined in: client.ts:106
Parameters
Parameter | Type |
---|---|
results | unknown |
Returns
any
Inherited from
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
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
remove()
remove(
id
,searchOptions
):Promise
<AssetIDResponse
>
Defined in: assets.ts:31
Parameters
Parameter | Type |
---|---|
id | string |
searchOptions | Partial |
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 | Partial | {} |
Returns
Promise
<string
>
upload()
upload(
data
,query
):Promise
<AssetIDResponse
>
Defined in: assets.ts:14
Parameters
Parameter | Type |
---|---|
data | PostData |
query | AssetUploadQuery |
Returns
Promise
<AssetIDResponse
>