Class BinarySession

constructor

• new BinarySession(createClient: BinaryClientFactory): BinarySession

  Parameters

  • createClient: BinaryClientFactory

  Returns BinarySession

ReadonlycreateClient

callTool

• callTool(
      name: string,
      arguments_: Readonly<Record<string, JsonValue>>,
      options?: { signal?: AbortSignal },
  ): Promise<Result<JSONType, HopperError>>

  Invoke a Hopper tool against the active target. Calls may overlap, but a pending target transition prevents new calls from entering until the transition has settled.

  Parameters

  • name: string
  • arguments_: Readonly<Record<string, JsonValue>>
  • Optionaloptions: { signal?: AbortSignal }

  Returns Promise<Result<JSONType, HopperError>>

close

• close(): Promise<Result<null, HopperError>>

  Close the active target, if any.

  Returns Promise<Result<null, HopperError>>

open

• open(
      path: string,
      options?: { signal?: AbortSignal; targetKind?: "executable" | "database" },
  ): Promise<Result<BinaryTarget, HopperError>>

  Open or switch targets after draining calls against the current target. Returns the switch failure even if best-effort restoration also fails.

  Parameters

  • path: string
  • options: { signal?: AbortSignal; targetKind?: "executable" | "database" } = {}

  Returns Promise<Result<BinaryTarget, HopperError>>

status

• status(): JSONType

  Describe the active binary session.

  Returns JSONType