@nuclia/core / Exports / IRest
Interface: IRest
Implemented by
Table of contents
Methods
- checkAuthorization
- delete
- get
- getFullUrl
- getHeaders
- getObjectURL
- getStreamMessages
- getStreamedResponse
- getZoneSlug
- getZones
- head
- patch
- post
- put
Methods
checkAuthorization
▸ checkAuthorization(path): Observable<{ allowed: boolean ; roles: (KBRoles | NucliaDBRole)[] }>
Parameters
| Name | Type |
|---|---|
path | string |
Returns
Observable<{ allowed: boolean ; roles: (KBRoles | NucliaDBRole)[] }>
Defined in
libs/sdk-core/src/lib/models.ts:112
delete
▸ delete(path, extraHeaders?, synchronous?, zoneSlug?): Observable<void>
Parameters
| Name | Type |
|---|---|
path | string |
extraHeaders? | Object |
synchronous? | boolean |
zoneSlug? | string |
Returns
Observable<void>
Defined in
libs/sdk-core/src/lib/models.ts:97
get
▸ get<T>(path, extraHeaders?, doNotParse?, zoneSlug?): Observable<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
path | string |
extraHeaders? | Object |
doNotParse? | boolean |
zoneSlug? | string |
Returns
Observable<T>
Defined in
libs/sdk-core/src/lib/models.ts:64
getFullUrl
▸ getFullUrl(path): string
Parameters
| Name | Type |
|---|---|
path | string |
Returns
string
Defined in
libs/sdk-core/src/lib/models.ts:106
getHeaders
▸ getHeaders(method, path, extraHeaders?, synchronous?): Object
Parameters
| Name | Type |
|---|---|
method | string |
path | string |
extraHeaders? | Object |
synchronous? | boolean |
Returns
Object
Defined in
libs/sdk-core/src/lib/models.ts:114
getObjectURL
▸ getObjectURL(path): Observable<string>
Parameters
| Name | Type |
|---|---|
path | string |
Returns
Observable<string>
Defined in
libs/sdk-core/src/lib/models.ts:107
getStreamMessages
▸ getStreamMessages(path, controller): Observable<{ data: Uint8Array ; headers: Headers }>
Parameters
| Name | Type |
|---|---|
path | string |
controller | AbortController |
Returns
Observable<{ data: Uint8Array ; headers: Headers }>
Defined in
libs/sdk-core/src/lib/models.ts:111
getStreamedResponse
▸ getStreamedResponse(path, body): Observable<{ data: Uint8Array ; headers: Headers ; incomplete: boolean }>
Parameters
| Name | Type |
|---|---|
path | string |
body | any |
Returns
Observable<{ data: Uint8Array ; headers: Headers ; incomplete: boolean }>
Defined in
libs/sdk-core/src/lib/models.ts:109
getZoneSlug
▸ getZoneSlug(zoneId): Observable<string>
Parameters
| Name | Type |
|---|---|
zoneId | string |
Returns
Observable<string>
Defined in
libs/sdk-core/src/lib/models.ts:105
getZones
▸ getZones(): Observable<{ [key: string]: string; }>
Returns
Observable<{ [key: string]: string; }>
Defined in
libs/sdk-core/src/lib/models.ts:104
head
▸ head(path, extraHeaders?): Observable<Response>
Parameters
| Name | Type |
|---|---|
path | string |
extraHeaders? | Object |
Returns
Observable<Response>
Defined in
libs/sdk-core/src/lib/models.ts:103
patch
▸ patch<T>(path, body, extraHeaders?, doNotParse?, synchronous?, zoneSlug?): Observable<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
path | string |
body | any |
extraHeaders? | Object |
doNotParse? | boolean |
synchronous? | boolean |
zoneSlug? | string |
Returns
Observable<T>
Defined in
libs/sdk-core/src/lib/models.ts:88
post
▸ post<T>(path, body, extraHeaders?, doNotParse?, synchronous?, zoneSlug?): Observable<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
path | string |
body | any |
extraHeaders? | Object |
doNotParse? | boolean |
synchronous? | boolean |
zoneSlug? | string |
Returns
Observable<T>
Defined in
libs/sdk-core/src/lib/models.ts:70
put
▸ put<T>(path, body, extraHeaders?, doNotParse?, synchronous?, zoneSlug?): Observable<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
path | string |
body | any |
extraHeaders? | Object |
doNotParse? | boolean |
synchronous? | boolean |
zoneSlug? | string |
Returns
Observable<T>