fluencelabs/aqua
1
0
Fork 0
mirror of https://github.com/fluencelabs/aqua.git synced 2024-12-04 06:30:17 +00:00
Code Issues Projects Releases Wiki Activity

feat: export types from aqua-api (#904)

Browse Source 
* feat: export types from aqua-api

* improve
This commit is contained in:
shamsartem 2023-09-18 18:39:59 +02:00 committed by GitHub
parent 54ddcc8b62
commit 594f46529d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
api/api-npm/index.d.ts vendored
View File

@ -1,11 +1,11 @@
import { ServiceDef, FunctionCallDef } from "@fluencelabs/interfaces";
class AquaFunction {
export class AquaFunction {
funcDef: FunctionCallDef;
script: string;
}
class GeneratedSource {
export class GeneratedSource {
name: string;
tsSource?: string;
jsSource?: string;
@ -43,20 +43,26 @@ type CodeString = {
code: string;
};
export type CompileFromStringArgs = CommonArgs & CodeString;
export type CompileFromStringReturnType = Omit<CompilationResult, "funcCall">;
/** Compile aqua code from a string */
export declare function compileFromString(
args: CommonArgs & CodeString,
): Promise<Omit<CompilationResult, "funcCall">>;
args: CompileFromStringArgs,
): Promise<CompileFromStringReturnType>;
type FilePath = {
/** Path to the aqua file to be compiled */
filePath: string;
};
export type CompileFromPathArgs = CommonArgs & FilePath;
export type CompileFromPathReturnType = Omit<CompilationResult, "funcCall">;
/** Compile aqua code from a file */
export declare function compileFromPath(
args: CommonArgs & FilePath,
): Promise<Omit<CompilationResult, "funcCall">>;
args: CompileFromPathArgs,
): Promise<CompileFromPathReturnType>;
type FuncCall = {
/** Function call you want to compile. Example: someFunc("someArg") */
@ -65,14 +71,20 @@ type FuncCall = {
data?: Record<string, unknown> | undefined;
};
export type CompileFuncCallFromStringArgs = CommonArgs & CodeString & FuncCall;
export type CompileFuncCallFromStringReturnType = Required<CompilationResult>;
/** Compile aqua function call from a string */
export declare function compileAquaCallFromString(
args: CommonArgs & CodeString & FuncCall,
): Promise<Required<CompilationResult>>;
args: CompileFuncCallFromStringArgs,
): Promise<CompileFuncCallFromStringReturnType>;
export type CompileFuncCallFromPathArgs = CommonArgs & FilePath & FuncCall;
export type CompileFuncCallFromPathReturnType = Required<CompilationResult>;
/** Compile aqua function call from a file */
export declare function compileAquaCallFromPath(
args: CommonArgs & FilePath & FuncCall,
): Promise<Required<CompilationResult>>;
args: CompileFuncCallFromPathArgs,
): Promise<CompileFuncCallFromPathReturnType>;
export {};