Type Alias QueryAPI

type QueryAPI = {
    adhoc(
        query: string,
        input?: any,
        pretty?: boolean,
        explain?: "notes" | "fails" | "full" | "debug",
        metrics?: boolean,
    ): Promise<ExecuteAdHocQueryResponse>;
    default<T = any>(input: any, pretty?: boolean): Promise<T>;
}

Index

Methods

adhoc default

Methods

adhoc

adhoc(
    query: string,
    input?: any,
    pretty?: boolean,
    explain?: "notes" | "fails" | "full" | "debug",
    metrics?: boolean,
): Promise<ExecuteAdHocQueryResponse>
Executes an ad-hoc Rego query.
Parameters
- query: string
  Rego query string.
- Optionalinput: any
  Optional input document.
- Optionalpretty: boolean
  Format response for humans.
- Optionalexplain: "notes" | "fails" | "full" | "debug"
  Include query explanation.
- Optionalmetrics: boolean
  Include performance metrics.
Returns Promise<ExecuteAdHocQueryResponse>
Query results with variable bindings.

See
https://www.openpolicyagent.org/docs/latest/rest-api/#execute-an-ad-hoc-query
- Defined in index.ts:173

default

default<T = any>(input: any, pretty?: boolean): Promise<T>
Executes the default decision query (POST /).
Type Parameters
- T = any
Parameters
- input: any
  Input document.
- Optionalpretty: boolean
  Format response for humans.
Returns Promise<T>
Result of /system/main or configured default decision.
Default
```
false
```
See
https://www.openpolicyagent.org/docs/latest/rest-api/#execute-a-simple-query
- Defined in index.ts:161

Type Alias QueryAPI

Index

Methods

Methods

adhoc

Parameters

Returns Promise<ExecuteAdHocQueryResponse>

See

default

Type Parameters

Parameters

Returns Promise<T>

Default

See

Settings

On This Page