EvalInObsidianParams<Input, Result, TContextId>
Parameters for evalInObsidian.
Import:
import type { EvalInObsidianParams } from 'obsidian-integration-testing';Signature:
export interface EvalInObsidianParams<Input extends GenericObject, Result, TContextId extends ContextId<unknown> | undefined = undefined>Properties
| Property | Type | Description |
|---|---|---|
| contextId? | TContextId | A ContextId linking this call to a persistent store on window in the Obsidian process. The callback receives a typed context object that survives across calls sharing the same ID.When omitted, context is a fresh empty object each call. |
| input? | Input | Additional arguments to pass to the function. Values may include functions — they are serialized via toString(). |
| shouldSkipPreflightChecks? | boolean | Skips pre-flight checks (vault registration, CLI availability). Used internally by vault registration functions. |
| transport? | ObsidianTransport | Override the transport for this call. When omitted, uses the transport configured via the context provider (set by the framework adapter's global setup). |
| vaultPath? | string | The path to the Obsidian vault. Defaults to process.cwd(). |
Methods
| Method | Returns | Description |
|---|---|---|
| callback(input) | Promisable<Result> | The function to evaluate in the Obsidian context. |
Links to this page: