Class OpaApiClient

Hierarchy

ClientSDK
- OpaApiClient

Index

Constructors

Properties

Methods

createRequest$ do$ executeBatchPolicyWithInput executeDefaultPolicyWithInput executePolicy executePolicyWithInput health

Constructors

constructor

new OpaApiClient(options?): OpaApiClient
Parameters
- options: SDKOptions = {}
Returns OpaApiClient
Inherited from ClientSDK.constructor
- Defined in packages/opa/src/lib/sdks.ts:82

Properties

`Readonly`options$

options$: SDKOptions & {
hooks?: SDKHooks;
}

Methods

createRequest$

createRequest$(context, conf, options?): Result<Request, UnexpectedClientError | InvalidRequestError>
Parameters
- context: HookContext
- conf: RequestConfig
- Optionaloptions: RequestOptions
Returns Result<Request, UnexpectedClientError | InvalidRequestError>
Inherited from ClientSDK.createRequest$
- Defined in packages/opa/src/lib/sdks.ts:109

do$

do$(request, options): Promise<Result<Response,
    | UnexpectedClientError
    | RequestAbortedError
    | RequestTimeoutError
    | ConnectionError>>
Parameters
- request: Request
- options: {
      context: HookContext;
      errorCodes: string | number | (string | number)[];
      retryCodes?: string[];
      retryConfig?: RetryConfig;
  }
  - context: HookContext
  - errorCodes: string | number | (string | number)[]
  - OptionalretryCodes?: string[]
  - OptionalretryConfig?: RetryConfig
Returns Promise<Result<Response,
    | UnexpectedClientError
    | RequestAbortedError
    | RequestTimeoutError
    | ConnectionError>>
Inherited from ClientSDK.do$
- Defined in packages/opa/src/lib/sdks.ts:204

executeBatchPolicyWithInput

executeBatchPolicyWithInput(request, options?): Promise<ExecuteBatchPolicyWithInputResponse>
Execute a policy given a batch of inputs
Parameters
- request: ExecuteBatchPolicyWithInputRequest
- Optionaloptions: RequestOptions
Returns Promise<ExecuteBatchPolicyWithInputResponse>
- Defined in packages/opa/src/sdk/sdk.ts:53

executeDefaultPolicyWithInput

executeDefaultPolicyWithInput(input, pretty?, acceptEncoding?, options?): Promise<ExecuteDefaultPolicyWithInputResponse>
Execute the default decision given an input
Parameters
- input: Input
- Optionalpretty: boolean
- OptionalacceptEncoding: Gzip
- Optionaloptions: RequestOptions
Returns Promise<ExecuteDefaultPolicyWithInputResponse>
- Defined in packages/opa/src/sdk/sdk.ts:19

executePolicy

executePolicy(request, options?): Promise<ExecutePolicyResponse>
Execute a policy
Parameters
- request: ExecutePolicyRequest
- Optionaloptions: RequestOptions
Returns Promise<ExecutePolicyResponse>
- Defined in packages/opa/src/sdk/sdk.ts:33

executePolicyWithInput

executePolicyWithInput(request, options?): Promise<ExecutePolicyWithInputResponse>
Execute a policy given an input
Parameters
- request: ExecutePolicyWithInputRequest
- Optionaloptions: RequestOptions
Returns Promise<ExecutePolicyWithInputResponse>
- Defined in packages/opa/src/sdk/sdk.ts:43

health

health(bundles?, plugins?, excludePlugin?, options?): Promise<HealthResponse>
Verify the server is operational
Parameters
- Optionalbundles: boolean
- Optionalplugins: boolean
- OptionalexcludePlugin: string[]
- Optionaloptions: RequestOptions
Returns Promise<HealthResponse>
Remarks
The health API endpoint executes a simple built-in policy query to verify that the server is operational. Optionally it can account for bundle activation as well (useful for “ready” checks at startup).
- Defined in packages/opa/src/sdk/sdk.ts:66

Class OpaApiClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OpaApiClient

Properties

Readonlyoptions$

Methods

createRequest$

Parameters

Returns Result<Request, UnexpectedClientError | InvalidRequestError>

do$

Parameters

context: HookContext

errorCodes: string | number | (string | number)[]

OptionalretryCodes?: string[]

OptionalretryConfig?: RetryConfig

Returns Promise<Result<Response, | UnexpectedClientError | RequestAbortedError | RequestTimeoutError | ConnectionError>>

executeBatchPolicyWithInput

Parameters

Returns Promise<ExecuteBatchPolicyWithInputResponse>

executeDefaultPolicyWithInput

Parameters

Returns Promise<ExecuteDefaultPolicyWithInputResponse>

executePolicy

Parameters

Returns Promise<ExecutePolicyResponse>

executePolicyWithInput

Parameters

Returns Promise<ExecutePolicyWithInputResponse>

health

Parameters

Returns Promise<HealthResponse>

Remarks

Settings

On This Page

`Readonly`options$

`Optional`retryCodes?: string[]

`Optional`retryConfig?: RetryConfig

Returns Promise<Result<Response,
| UnexpectedClientError
| RequestAbortedError
| RequestTimeoutError
| ConnectionError>>