the-wireguard-effect
Version:
Cross platform wireguard api client for nodejs built on wireguard-go with effect-ts
67 lines • 2.91 kB
TypeScript
/**
* Wireguard control mechanisms.
*
* @since 1.0.0
*/
import type * as CommandExecutor from "@effect/platform/CommandExecutor";
import type * as PlatformError from "@effect/platform/Error";
import type * as FileSystem from "@effect/platform/FileSystem";
import type * as Path from "@effect/platform/Path";
import type * as Socket from "@effect/platform/Socket";
import type * as Cause from "effect/Cause";
import type * as Context from "effect/Context";
import type * as Effect from "effect/Effect";
import type * as ParseResult from "effect/ParseResult";
import type * as Scope from "effect/Scope";
import type * as exec from "node:child_process";
import type * as WireguardConfig from "./WireguardConfig.js";
import type * as WireguardInterface from "./WireguardInterface.js";
import * as Layer from "effect/Layer";
/**
* @since 1.0.0
* @category Type ids
*/
export declare const TypeId: unique symbol;
/**
* @since 1.0.0
* @category Type ids
*/
export type TypeId = typeof TypeId;
/**
* @since 1.0.0
* @category Models
*/
export interface WireguardControl {
readonly [TypeId]: TypeId;
readonly up: (wireguardConfig: WireguardConfig.WireguardConfig, wireguardInterface: WireguardInterface.WireguardInterface) => Effect.Effect<WireguardInterface.WireguardInterface, Socket.SocketError | ParseResult.ParseError | PlatformError.PlatformError | Cause.TimeoutException, FileSystem.FileSystem | Path.Path | CommandExecutor.CommandExecutor>;
readonly down: (wireguardConfig: WireguardConfig.WireguardConfig, wireguardInterface: WireguardInterface.WireguardInterface, wireguardGoProcess?: exec.ChildProcess) => Effect.Effect<WireguardInterface.WireguardInterface, PlatformError.PlatformError | ParseResult.ParseError | Cause.TimeoutException, FileSystem.FileSystem | Path.Path | CommandExecutor.CommandExecutor>;
readonly upScoped: (wireguardConfig: WireguardConfig.WireguardConfig, wireguardInterface: WireguardInterface.WireguardInterface) => Effect.Effect<WireguardInterface.WireguardInterface, Socket.SocketError | ParseResult.ParseError | PlatformError.PlatformError | Cause.TimeoutException, FileSystem.FileSystem | Path.Path | Scope.Scope | CommandExecutor.CommandExecutor>;
}
/**
* @since 1.0.0
* @category Tags
*/
export declare const WireguardControl: Context.Tag<WireguardControl, WireguardControl>;
/**
* @since 1.0.0
* @category Constructors
*/
export declare const makeBundledWgQuickLayer: (options: {
sudo: boolean;
}) => WireguardControl;
/**
* @since 1.0.0
* @category Constructors
*/
export declare const makeUserspaceLayer: () => WireguardControl;
/**
* @since 1.0.0
* @category Layers
*/
export declare const UserspaceLayer: Layer.Layer<WireguardControl, never, never>;
/**
* @since 1.0.0
* @category Layers
*/
export declare const BundledWgQuickLayer: Layer.Layer<WireguardControl, never, never>;
//# sourceMappingURL=WireguardControl.d.ts.map