@tai-kun/surrealdb
Version:
The SurrealDB SDK for JavaScript
23 lines • 1.16 kB
TypeScript
import type ClientBase from "@tai-kun/surrealdb/basic-client";
import type { ClientConfig } from "@tai-kun/surrealdb/basic-client";
import { type CreateSurqlConfig, type Surql } from "./surql/create-surql";
type ClientConstructor = new (config: ClientConfig) => ClientBase;
export interface SurrealInit<TClientConstructor extends ClientConstructor> extends ClientConfig, Omit<CreateSurqlConfig, "formatter"> {
readonly Client: TClientConstructor;
}
/**
* [API Reference](https://tai-kun.github.io/surrealdb.js/v2/guides/connecting/)
*/
export interface Surreal<TClientConstructor extends ClientConstructor> {
/**
* [API Reference](https://tai-kun.github.io/surrealdb.js/v2/guides/connecting/#constructor)
*/
new (): InstanceType<TClientConstructor> & AsyncDisposable;
}
export interface InitializedSurreal<TClientConstructor extends ClientConstructor> {
Surreal: Surreal<TClientConstructor>;
surql: Surql;
}
export default function initSurreal<TClientConstructor extends ClientConstructor>(init: SurrealInit<TClientConstructor>): InitializedSurreal<TClientConstructor>;
export {};
//# sourceMappingURL=init-surreal.d.ts.map