@k8slens/extensions

Globals / "src/renderer/api/json-api" / JsonApi

Class: JsonApi\

Type parameters

Name	Type	Default
D	-	JsonApiData
P	JsonApiParams	JsonApiParams

Hierarchy

• JsonApi

↳ KubeJsonApi

Index

Constructors

• constructor

Properties

• config
• onData
• onError
• reqInit

Methods

• del
• get
• parseError
• parseResponse
• patch
• post
• put
• request
• writeLog

Object literals

• configDefault
• reqInitDefault

Constructors

constructor

+ new JsonApi(config: JsonApiConfig, reqInit?: RequestInit): JsonApi

Defined in src/renderer/api/json-api.ts:43

Parameters:

Name	Type
config	JsonApiConfig
reqInit?	RequestInit

Returns: JsonApi

Properties

config

• Protected config: JsonApiConfig

Defined in src/renderer/api/json-api.ts:45

---

onData

• onData: EventEmitter\<[D, Response]> = new EventEmitter\<[D, Response]>()

Defined in src/renderer/api/json-api.ts:51

---

onError

• onError: EventEmitter\<[JsonApiErrorParsed, Response]> = new EventEmitter\<[JsonApiErrorParsed, Response]>()

Defined in src/renderer/api/json-api.ts:52

---

reqInit

• Protected Optional reqInit: RequestInit

Defined in src/renderer/api/json-api.ts:45

Methods

del

▸ del\(path: string, params?: P, reqInit?: RequestInit): CancelablePromise\

Defined in src/renderer/api/json-api.ts:70

Type parameters:

Name	Default
T	D

Parameters:

Name	Type	Default value
path	string	-
params?	P	-
reqInit	RequestInit	{}

Returns: CancelablePromise\

---

get

▸ get\(path: string, params?: P, reqInit?: RequestInit): CancelablePromise\

Defined in src/renderer/api/json-api.ts:54

Type parameters:

Name	Default
T	D

Parameters:

Name	Type	Default value
path	string	-
params?	P	-
reqInit	RequestInit	{}

Returns: CancelablePromise\

---

parseError

▸ ProtectedparseError(error: JsonApiError | string, res: Response): string[]

Defined in src/renderer/api/json-api.ts:119

Parameters:

Name	Type
error	JsonApiError | string
res	Response

Returns: string[]

---

parseResponse

▸ ProtectedparseResponse\(res: Response, log: JsonApiLog): Promise\

Defined in src/renderer/api/json-api.ts:95

Type parameters:

Name
D

Parameters:

Name	Type
res	Response
log	JsonApiLog

Returns: Promise\

---

patch

▸ patch\(path: string, params?: P, reqInit?: RequestInit): CancelablePromise\

Defined in src/renderer/api/json-api.ts:66

Type parameters:

Name	Default
T	D

Parameters:

Name	Type	Default value
path	string	-
params?	P	-
reqInit	RequestInit	{}

Returns: CancelablePromise\

---

post

▸ post\(path: string, params?: P, reqInit?: RequestInit): CancelablePromise\

Defined in src/renderer/api/json-api.ts:58

Type parameters:

Name	Default
T	D

Parameters:

Name	Type	Default value
path	string	-
params?	P	-
reqInit	RequestInit	{}

Returns: CancelablePromise\

---

put

▸ put\(path: string, params?: P, reqInit?: RequestInit): CancelablePromise\

Defined in src/renderer/api/json-api.ts:62

Type parameters:

Name	Default
T	D

Parameters:

Name	Type	Default value
path	string	-
params?	P	-
reqInit	RequestInit	{}

Returns: CancelablePromise\

---

request

▸ Protectedrequest\(path: string, params?: P, init?: RequestInit): CancelablePromise\

Defined in src/renderer/api/json-api.ts:74

Type parameters:

Name
D

Parameters:

Name	Type	Default value
path	string	-
params?	P	-
init	RequestInit	{}

Returns: CancelablePromise\

---

writeLog

▸ ProtectedwriteLog(log: JsonApiLog): void

Defined in src/renderer/api/json-api.ts:132

Parameters:

Name	Type
log	JsonApiLog

Returns: void

Object literals

configDefault

▪ Static configDefault: object

Defined in src/renderer/api/json-api.ts:41

Properties:

Name	Type	Value
debug	false	false

---

reqInitDefault

▪ Static reqInitDefault: object

Defined in src/renderer/api/json-api.ts:35

Properties:

Name	Type	Value
headers	object	{ content-type: string = "application/json" }

---

Last update: November 10, 2020