Class JsonldApi

Hierarchy

BaseAPI
- JsonldApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new JsonldApi(configuration?: Configuration): JsonldApi

Inherited from BaseAPI.constructor
- Defined in client/runtime.ts:24
Parameters
- configuration: Configuration = ...
Returns JsonldApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

jsonldSignPost

jsonldSignPost(requestParameters: JsonldSignPostRequest): Promise<SignResponse>

- Defined in client/apis/JsonldApi.ts:69
Sign a JSON-LD structure and return it

Parameters
- requestParameters: JsonldSignPostRequest
Returns Promise<SignResponse>

jsonldSignPostRaw

jsonldSignPostRaw(requestParameters: JsonldSignPostRequest): Promise<ApiResponse<SignResponse>>

- Defined in client/apis/JsonldApi.ts:44
Sign a JSON-LD structure and return it

Parameters
- requestParameters: JsonldSignPostRequest
Returns Promise<ApiResponse<SignResponse>>

jsonldVerifyPost

jsonldVerifyPost(requestParameters: JsonldVerifyPostRequest): Promise<VerifyResponse>

- Defined in client/apis/JsonldApi.ts:104
Verify a JSON-LD structure.

Parameters
- requestParameters: JsonldVerifyPostRequest
Returns Promise<VerifyResponse>

jsonldVerifyPostRaw

jsonldVerifyPostRaw(requestParameters: JsonldVerifyPostRequest): Promise<ApiResponse<VerifyResponse>>

- Defined in client/apis/JsonldApi.ts:79
Verify a JSON-LD structure.

Parameters
- requestParameters: JsonldVerifyPostRequest
Returns Promise<ApiResponse<VerifyResponse>>

Protected request

request(context: RequestOpts): Promise<Response>

Inherited from BaseAPI.request
- Defined in client/runtime.ts:50
Parameters
- context: RequestOpts
Returns Promise<Response>

withMiddleware

withMiddleware<T>(...middlewares: Middleware[]): T

Inherited from BaseAPI.withMiddleware
- Defined in client/runtime.ts:28
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...middlewares: Middleware[]
Returns T

withPostMiddleware

withPostMiddleware<T>(...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]): T

Inherited from BaseAPI.withPostMiddleware
- Defined in client/runtime.ts:42
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]
Returns T

withPreMiddleware

withPreMiddleware<T>(...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]): T

Inherited from BaseAPI.withPreMiddleware
- Defined in client/runtime.ts:34
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]
Returns T

Generated using TypeDoc