mirror of
https://github.com/fluencelabs/aqua.git
synced 2025-06-28 14:01:33 +00:00
feat: wrap aqua api (#807)
This commit is contained in:
50
api/api-npm/index.d.ts
vendored
Normal file
50
api/api-npm/index.d.ts
vendored
Normal file
@ -0,0 +1,50 @@
|
||||
import { type CompilationResult } from "./aqua-api.js";
|
||||
|
||||
/** Common arguments for all compile functions */
|
||||
type CommonArgs = {
|
||||
/** Paths to directories, which you want to import .aqua files from. Example: ["./path/to/dir"] */
|
||||
imports?: string[] | undefined;
|
||||
/** Constants to be passed to the compiler. Example: ["CONSTANT1=1", "CONSTANT2=2"] */
|
||||
constants?: string[] | undefined;
|
||||
/** Set log level for the compiler. Must be one of: Must be one of: all, trace, debug, info, warn, error, off. Default: info */
|
||||
logLevel?: string | undefined;
|
||||
/** Do not generate a pass through the relay node. Default: false */
|
||||
noRelay?: boolean | undefined;
|
||||
/** Do not generate a wrapper that catches and displays errors. Default: false */
|
||||
noXor?: boolean | undefined;
|
||||
/** Target type for the compiler. Must be one of: ts, js, air. Default: air */
|
||||
targetType?: "ts" | "js" | "air" | undefined;
|
||||
/** Compile aqua in tracing mode (for debugging purposes). Default: false */
|
||||
tracing?: boolean | undefined;
|
||||
};
|
||||
|
||||
type CodeString = {
|
||||
/** Aqua code to be compiled */
|
||||
code: string;
|
||||
}
|
||||
|
||||
/** Compile aqua code from a string */
|
||||
export declare function compileFromString(args: CommonArgs & CodeString): Promise<Omit<CompilationResult, 'funcCall'>>
|
||||
|
||||
type FilePath = {
|
||||
/** Path to the aqua file to be compiled */
|
||||
filePath: string;
|
||||
}
|
||||
|
||||
/** Compile aqua code from a file */
|
||||
export declare function compileFromPath(args: CommonArgs & FilePath): Promise<Omit<CompilationResult, 'funcCall'>>
|
||||
|
||||
type FuncCall = {
|
||||
/** Function call you want to compile. Example: someFunc("someArg") */
|
||||
funcCall: string;
|
||||
/** Args to be passed to the function (record with keys named as args you want to pass to the function) Example: { someArg: 1 } */
|
||||
data?: Record<string, unknown> | undefined;
|
||||
}
|
||||
|
||||
/** Compile aqua function call from a string */
|
||||
export declare function compileAquaCallFromString(args: CommonArgs & CodeString & FuncCall): Promise<Required<CompilationResult>>
|
||||
|
||||
/** Compile aqua function call from a file */
|
||||
export declare function compileAquaCallFromPath(args: CommonArgs & FilePath & FuncCall): Promise<Required<CompilationResult>>
|
||||
|
||||
export {}
|
Reference in New Issue
Block a user