Class: KubeJsonApi#
- -Hierarchy#
--
-
JsonApi<KubeJsonApiData>
-
↳ KubeJsonApi
Table of contents#
-Constructors#
--
-
- constructor -
Properties#
- -Methods#
--
-
- del -
- get -
- getResponse -
- parseError -
- parseResponse -
- patch -
- post -
- put -
- request -
- writeLog -
Constructors#
-constructor#
-• new KubeJsonApi(dependencies, config, reqInit?)
Parameters#
-| Name | -Type | -
|---|---|
dependencies |
-JsonApiDependencies |
-
config |
-JsonApiConfig |
-
reqInit? |
-RequestInit |
-
Inherited from#
-JsonApi<KubeJsonApiData>.constructor
-Properties#
-config#
-• Readonly config: JsonApiConfig
Inherited from#
-JsonApi.config
--
dependencies#
-• Protected Readonly dependencies: JsonApiDependencies
Inherited from#
-JsonApi.dependencies
--
onData#
-• Readonly onData: EventEmitter<[KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>, Response]>
Inherited from#
-JsonApi.onData
--
onError#
-• Readonly onError: EventEmitter<[JsonApiErrorParsed, Response]>
Inherited from#
-JsonApi.onError
--
reqInit#
-• Protected Readonly reqInit: Defaulted<RequestInit, "headers">
Inherited from#
-JsonApi.reqInit
--
configDefault#
-▪ Static Readonly configDefault: Partial<JsonApiConfig>
Inherited from#
-JsonApi.configDefault
--
reqInitDefault#
-▪ Static Readonly reqInitDefault: Object
Type declaration#
-| Name | -Type | -
|---|---|
headers |
-{ content-type: string = "application/json" } |
-
headers.content-type |
-string |
-
Inherited from#
-JsonApi.reqInitDefault
-Methods#
-del#
-▸ del<OutData, Query>(path, params?, reqInit?): Promise<OutData>
Type parameters#
-| Name | -Type | -
|---|---|
OutData |
-KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown> |
-
Query |
-Partial<Record<string, QueryParam>> |
-
Parameters#
-| Name | -Type | -
|---|---|
path |
-string |
-
params? |
-ParamsAndQuery<JsonApiParams<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>, Query> |
-
reqInit |
-RequestInit |
-
Returns#
-Promise<OutData>
Inherited from#
-JsonApi.del
--
get#
-▸ get<OutData, Query>(path, params?, reqInit?): Promise<OutData>
Type parameters#
-| Name | -Type | -
|---|---|
OutData |
-KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown> |
-
Query |
-Partial<Record<string, QueryParam>> |
-
Parameters#
-| Name | -Type | -
|---|---|
path |
-string |
-
params? |
-ParamsAndQuery<JsonApiParams<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>, Query> |
-
reqInit |
-RequestInit |
-
Returns#
-Promise<OutData>
Inherited from#
-JsonApi.get
--
getResponse#
-▸ getResponse<Query>(path, params?, init?): Promise<Response>
Type parameters#
-| Name | -
|---|
Query |
-
Parameters#
-| Name | -Type | -
|---|---|
path |
-string |
-
params? |
-ParamsAndQuery<JsonApiParams<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>, Query> |
-
init |
-RequestInit |
-
Returns#
-Promise<Response>
Inherited from#
-JsonApi.getResponse
--
parseError#
-▸ Protected parseError(error, res): string[]
Parameters#
-| Name | -Type | -
|---|---|
error |
-string | KubeJsonApiError |
-
res |
-Response |
-
Returns#
-string[]
Overrides#
-JsonApi.parseError
--
parseResponse#
-▸ Protected parseResponse<OutData>(res, log): Promise<OutData>
Type parameters#
-| Name | -
|---|
OutData |
-
Parameters#
-| Name | -Type | -
|---|---|
res |
-Response |
-
log |
-JsonApiLog |
-
Returns#
-Promise<OutData>
Inherited from#
-JsonApi.parseResponse
--
patch#
-▸ patch<OutData, Query>(path, params?, reqInit?): Promise<OutData>
Type parameters#
-| Name | -Type | -
|---|---|
OutData |
-KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown> |
-
Query |
-Partial<Record<string, QueryParam>> |
-
Parameters#
-| Name | -Type | -
|---|---|
path |
-string |
-
params? |
-ParamsAndQuery<Omit<JsonApiParams<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>, "data">, Query> & { data?: Patch | PartialObjectDeep<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>> } |
-
reqInit |
-RequestInit |
-
Returns#
-Promise<OutData>
Inherited from#
-JsonApi.patch
--
post#
-▸ post<OutData, Query>(path, params?, reqInit?): Promise<OutData>
Type parameters#
-| Name | -Type | -
|---|---|
OutData |
-KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown> |
-
Query |
-Partial<Record<string, QueryParam>> |
-
Parameters#
-| Name | -Type | -
|---|---|
path |
-string |
-
params? |
-ParamsAndQuery<JsonApiParams<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>, Query> |
-
reqInit |
-RequestInit |
-
Returns#
-Promise<OutData>
Inherited from#
-JsonApi.post
--
put#
-▸ put<OutData, Query>(path, params?, reqInit?): Promise<OutData>
Type parameters#
-| Name | -Type | -
|---|---|
OutData |
-KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown> |
-
Query |
-Partial<Record<string, QueryParam>> |
-
Parameters#
-| Name | -Type | -
|---|---|
path |
-string |
-
params? |
-ParamsAndQuery<JsonApiParams<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>, Query> |
-
reqInit |
-RequestInit |
-
Returns#
-Promise<OutData>
Inherited from#
-JsonApi.put
--
request#
-▸ Protected request<OutData, Query>(path, params, init): Promise<OutData>
Type parameters#
-| Name | -Type | -
|---|---|
OutData |
-OutData |
-
Query |
-Partial<Record<string, QueryParam>> |
-
Parameters#
-| Name | -Type | -
|---|---|
path |
-string |
-
params |
-undefined | ParamsAndQuery<Omit<JsonApiParams<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>, "data">, Query> & { data?: unknown } |
-
init |
-Defaulted<RequestInit, "method"> |
-
Returns#
-Promise<OutData>
Inherited from#
-JsonApi.request
--
writeLog#
-▸ Protected writeLog(log): void
Parameters#
-| Name | -Type | -
|---|---|
log |
-JsonApiLog |
-
Returns#
-void
Inherited from#
-JsonApi.writeLog
- - - - - - - -