Class Polar<Query, Resource>

Create and manage an instance of the Polar runtime.

Type parameters

Query
Resource

Hierarchy

Polar
- Oso

Index

Constructors

constructor

Methods

Constructors

constructor

new Polar<Query, Resource>(opts?: Options): Polar<Query, Resource>

- Defined in src/Polar.ts:60
Type parameters
- Query
- Resource
Parameters
- opts: Options = {}
Returns Polar<Query, Resource>

Methods

clearRules

clearRules(): void

- Defined in src/Polar.ts:118
Clear rules from the Polar KB, but retain all registered classes and constants.

Returns void

free

free(): void

- Defined in src/Polar.ts:97
Free the underlying WASM instance.

Invariant: ensure that you do not do anything else with an instance after calling free() on it.

This should not be something you need to do during the course of regular usage. It's generally only useful for scenarios where large numbers of instances are spun up and not cleanly reaped by the GC, such as during a long-running test process in 'watch' mode.

Returns void

getFfi

getFfi(): Polar

- Defined in src/Polar.ts:262
Returns Polar

getHost

getHost(): Host<Query, Resource>

- Defined in src/Polar.ts:258
Returns Host<Query, Resource>

loadFile

loadFile(filename: string): Promise<void>

- Defined in src/Polar.ts:158
Load a Polar policy file.

deprecated

Oso.loadFile has been deprecated in favor of Oso.loadFiles as of the 0.20 release. Please see changelog for migration instructions: https://docs.osohq.com/project/changelogs/2021-09-15.html

Parameters
- filename: string
Returns Promise<void>

loadFiles

loadFiles(filenames: string[]): Promise<void>

- Defined in src/Polar.ts:126
Load Polar policy files.

Parameters
- filenames: string[]
Returns Promise<void>

loadStr

loadStr(contents: string, filename?: string): Promise<void>

- Defined in src/Polar.ts:169
Load a Polar policy string.

Parameters
- contents: string
- Optional filename: string
Returns Promise<void>

query

query(q: string | Predicate, opts?: QueryOpts): QueryResult

- Defined in src/Polar.ts:196
Query for a Polar predicate or string.

Parameters
- q: string | Predicate
- Optional opts: QueryOpts
Returns QueryResult

queryRule

queryRule(opts: QueryOpts, name: string, ...args: unknown[]): QueryResult
queryRule(name: string, ...args: unknown[]): QueryResult

- Defined in src/Polar.ts:215
Query for a Polar rule.

Parameters
- opts: QueryOpts
- name: string
- Rest ...args: unknown[]
Returns QueryResult
- Defined in src/Polar.ts:216
Parameters
- name: string
- Rest ...args: unknown[]
Returns QueryResult

queryRuleOnce

queryRuleOnce(name: string, ...args: unknown[]): Promise<boolean>

- Defined in src/Polar.ts:231
Query for a Polar rule, returning true if there are any results.

Parameters
- name: string
- Rest ...args: unknown[]
Returns Promise<boolean>

registerClass

registerClass(cls: Class<unknown>, params?: ClassParams): void

- Defined in src/Polar.ts:244
Register a JavaScript class for use in Polar policies.

Parameters
- cls: Class<unknown>
  
  The class to register.
- Optional params: ClassParams
  
  An optional object with extra parameters.
Returns void

registerConstant

registerConstant(value: unknown, name: string): void

- Defined in src/Polar.ts:253
Register a JavaScript value for use in Polar policies.

Parameters
- value: unknown
- name: string
Returns void

repl

repl(files?: string[]): Promise<void>

- Defined in src/Polar.ts:267
Start a REPL session.

Parameters
- Optional files: string[]
Returns Promise<void>