Interface OPAClient

Abstracts the methods that are used from OPAClient of @open-policy-agent/opa.

interface OPAClient {
    evaluate<In extends Input | ToInput, Res>(
        path: string,
        input?: In,
        opts?: RequestOptions<Res>,
    ): Promise<Res>;
    evaluateBatch<In extends Input | ToInput, Res>(
        path: string,
        inputs: { [k: string]: In },
        opts?: BatchRequestOptions<Res>,
    ): Promise<{ [k: string]: ServerErrorWithStatusCode | Res }>;
    evaluateDefault<In extends Input | ToInput, Res>(
        input?: In,
        opts?: RequestOptions<Res>,
    ): Promise<Res>;
}

Index

Methods

evaluate evaluateBatch evaluateDefault

Methods

evaluate

evaluate<In extends Input | ToInput, Res>(
    path: string,
    input?: In,
    opts?: RequestOptions<Res>,
): Promise<Res>
Evaluate a policy at path, with optional input and RequestOptions.
Type Parameters
- In extends Input | ToInput
- Res
Parameters
- path: string
- Optionalinput: In
- Optionalopts: RequestOptions<Res>
Returns Promise<Res>
- Defined in packages/opa-react/src/authz-provider.tsx:79

evaluateBatch

evaluateBatch<In extends Input | ToInput, Res>(
    path: string,
    inputs: { [k: string]: In },
    opts?: BatchRequestOptions<Res>,
): Promise<{ [k: string]: ServerErrorWithStatusCode | Res }>
Evaluate a policy against a batch of inputs.
Type Parameters
- In extends Input | ToInput
- Res
Parameters
- path: string
- inputs: { [k: string]: In }
- Optionalopts: BatchRequestOptions<Res>
Returns Promise<{ [k: string]: ServerErrorWithStatusCode | Res }>
- Defined in packages/opa-react/src/authz-provider.tsx:92

evaluateDefault

evaluateDefault<In extends Input | ToInput, Res>(
input?: In,
opts?: RequestOptions<Res>,
): Promise<Res>
Evaluate the server's default policy, with optional input and RequestOptions.
Type Parameters
- In extends Input | ToInput
- Res
Parameters
- Optionalinput: In
- Optionalopts: RequestOptions<Res>
Returns Promise<Res>
- Defined in packages/opa-react/src/authz-provider.tsx:86