@wxn0brp/vql-client

Minimalistic, pluggable client for VQL query execution.

Supports:

• ESM (import)
• CDN / <script> (VQLClient)
• Fully typed with TypeScript
• Custom transport layers and lifecycle hooks

Installation

npm install @wxn0brp/vql-client

DOCS

API Reference

Usage

ESM

import { fetchVQL, VConfig } from "@wxn0brp/vql-client";

const result = await fetchVQL("db1 user! s._id = xyz");

CDN

<script src="https://unpkg.com/@wxn0brp/vql-client/dist/min.js"></script>
<script>
  VQLClient.fetchVQL("db1 user! s._id = xyz").then(console.log);
</script>

fetchVQL<T = any>(query: string | object, vars?: Object, hookContext?: Object, fetchOptions?: FetchOptions): Promise<T>

Executes a VQL query and returns the result (unwrapped from { result }, unless an error is present).

VConfig

Customize client behavior.

Example – custom transport and hooks:

VConfig.transport = async (query) => {
  return await fetch("/VQL", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({ query })
  }).then(res => res.json());
}
VConfig.hooks = {
  onStart: (query, ctx) => console.log("VQL start", query),
  onEnd: (q, time, res, ctx) => console.log("VQL end", time + "ms", res),
  onError: (q, e, ctx) => console.error("VQL error", e)
}

Default Transport

defTransport(query): Promise<any>

Sends:

POST /VQL
Content-Type: application/json
Body: { query }

Returns:

{
  result: any,
  err?: string
}

About Releases

Some releases may not have associated source code commits (e.g., 0.2.8, 0.2.7). These releases contain type definition updates only.

The vql.d.ts file is not maintained in this repository. During the release process, it is fetched (via curl) from the main project repository and included in the published package. If only the external type definitions change, a new version is published without modifying this repository’s source code.

License

MIT. See LICENSE

Contributing

Contributions are welcome!