Teraslice Client (JavaScript): `Assets Default`
assets.default
Hierarchy
-
↳
default
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new default(config
): default
Parameters
Name | Type |
---|---|
config | ClientConfig |
Returns
Overrides
Defined in
Properties
_config
• Protected
Readonly
_config: ClientConfig
Inherited from
Defined in
Methods
delete
▸ delete<T
>(endpoint
, options?
): Promise
<T
>
Type parameters
Name | Type |
---|---|
T | any |
Parameters
Name | Type |
---|---|
endpoint | string |
options? | SearchOptions |
Returns
Promise
<T
>
Inherited from
Defined in
get
▸ get<T
>(endpoint
, options?
): Promise
<T
>
Type parameters
Name | Type |
---|---|
T | any |
Parameters
Name | Type |
---|---|
endpoint | string |
options? | SearchOptions |
Returns
Promise
<T
>
Inherited from
Defined in
getAsset
▸ getAsset(name
, version?
, searchOptions?
): Promise
<AssetRecord
[]>
Parameters
Name | Type | Default value |
---|---|---|
name | string | undefined |
version | string | '' |
searchOptions | SearchOptions | {} |
Returns
Promise
<AssetRecord
[]>
Defined in
list
▸ list(query?
, searchOptions?
): Promise
<AssetRecord
[]>
Parameters
Name | Type |
---|---|
query | SearchQuery |
searchOptions | SearchOptions |
Returns
Promise
<AssetRecord
[]>
Defined in
makeOptions
▸ makeOptions(searchParams
, options
): Options
Parameters
Name | Type | |
---|---|---|
searchParams | undefined \ | Record <string , any > |
options | Options \ | SearchOptions |
Returns
Options
Inherited from
Defined in
parse
▸ parse(results
): any
Parameters
Name | Type |
---|---|
results | unknown |
Returns
any
Inherited from
Defined in
post
▸ post<T
>(endpoint
, data?
, options?
): Promise
<T
>
Type parameters
Name | Type |
---|---|
T | any |
Parameters
Name | Type |
---|---|
endpoint | string |
data? | unknown |
options? | Options |
Returns
Promise
<T
>
Inherited from
Defined in
put
▸ put<T
>(endpoint
, data
, options?
): Promise
<T
>
Type parameters
Name | Type |
---|---|
T | any |
Parameters
Name | Type |
---|---|
endpoint | string |
data | unknown |
options? | Options |
Returns
Promise
<T
>
Inherited from
Defined in
remove
▸ remove(id
, searchOptions?
): Promise
<AssetIDResponse
>
Parameters
Name | Type |
---|---|
id | string |
searchOptions | SearchOptions |
Returns
Promise
<AssetIDResponse
>
Defined in
txt
▸ txt(name?
, version?
, query?
, searchOptions?
): Promise
<string
>
Parameters
Name | Type | Default value |
---|---|---|
name | string | '' |
version | string | '' |
query | TxtSearchParams | {} |
searchOptions | SearchOptions | {} |
Returns
Promise
<string
>
Defined in
upload
▸ upload(data
, query?
): Promise
<AssetIDResponse
>
Parameters
Name | Type |
---|---|
data | PostData |
query | AssetUploadQuery |
Returns
Promise
<AssetIDResponse
>