Type Alias CompileAPI

type CompileAPI = {
    filter(
        path: string,
        req: CompileFilterRequest,
        accept: string,
    ): Promise<CompileFilterResponse>;
    partialEval(
        req: PartialEvalRequest,
        pretty?: boolean,
        explain?: "notes" | "fails" | "full" | "debug",
        metrics?: boolean,
        instrument?: boolean,
    ): Promise<PartialEvalResponse>;
}

Index

Methods

filter partialEval

Methods

filter

filter(
    path: string,
    req: CompileFilterRequest,
    accept: string,
): Promise<CompileFilterResponse>
Compiles a Rego policy into data filters (e.g., SQL).
Parameters
- path: string
  Filter rule path (e.g., 'filters/include').
- req: CompileFilterRequest
  Compile request.
- accept: string
  Accept header (e.g., 'application/vnd.opa.sql.postgresql+json').
Returns Promise<CompileFilterResponse>
Generated filter (e.g., SQL WHERE clause).

See
https://www.openpolicyagent.org/docs/latest/rest-api/#compling-a-rego-policy-and-query-into-data-filters
- Defined in index.ts:197

partialEval

partialEval(
    req: PartialEvalRequest,
    pretty?: boolean,
    explain?: "notes" | "fails" | "full" | "debug",
    metrics?: boolean,
    instrument?: boolean,
): Promise<PartialEvalResponse>
Partially evaluates a query.
Parameters
- req: PartialEvalRequest
  Partial evaluation request.
- Optionalpretty: boolean
  Format response for humans.
- Optionalexplain: "notes" | "fails" | "full" | "debug"
  Include query explanation.
- Optionalmetrics: boolean
  Include performance metrics.
- Optionalinstrument: boolean
  Enable detailed instrumentation.
Returns Promise<PartialEvalResponse>
Partially evaluated queries or unconditional result.

See
https://www.openpolicyagent.org/docs/latest/rest-api/#partially-evaluate-a-query
- Defined in index.ts:188

Type Alias CompileAPI

Index

Methods

Methods

filter

Parameters

Returns Promise<CompileFilterResponse>

See

partialEval

Parameters

Returns Promise<PartialEvalResponse>

See

Settings

On This Page