Instantiate a PolywrapClient
Optional config: CoreClientConfiga client configuration
Returns the configuration used to instantiate the client
an immutable Polywrap client config
returns an env (a set of environmental variables) from the configuration used to instantiate the client
the URI used to register the env
an env, or undefined if an env is not found at the given URI
returns all env registrations from the configuration used to instantiate the client
an array of env objects containing wrapper environmental variables
returns a file contained in a wrap package
a wrap URI
{ path: string; encoding?: "utf-8" | string }
a Promise of a Result containing a file if the request was successful
returns the interface implementations associated with an interface URI from the configuration used to instantiate the client
a wrap URI
Optional options: GetImplementationsOptions{ applyResolution?: boolean; resolutionContext?: IUriResolutionContext }
a Result containing URI array if the request was successful
returns all interfaces from the configuration used to instantiate the client
an array of interfaces and their registered implementations
returns the URI resolver from the configuration used to instantiate the client
an object that implements the IUriResolver interface
Invoke a wrapper.
{ // The Wrapper's URI uri: TUri;
// Method to be executed. method: string;
//Arguments for the method, structured as a map, removing the chance of incorrectly ordered arguments. args?: Record<string, unknown> | Uint8Array;
// Env variables for the wrapper invocation. env?: Record<string, unknown>;
// A Uri resolution context resolutionContext?: IUriResolutionContext;
// if true, return value is a msgpack-encoded byte array encodeResult?: boolean; }
A Promise with a Result containing the return value or an error
Unlike invokeWrapper, this method automatically retrieves and caches the wrapper.
Invoke a wrapper using an instance of the wrapper.
{ // The Wrapper's URI uri: TUri;
// Method to be executed. method: string;
//Arguments for the method, structured as a map, removing the chance of incorrectly ordered arguments. args?: Record<string, unknown> | Uint8Array;
// Env variables for the wrapper invocation. env?: Record<string, unknown>;
// A Uri resolution context resolutionContext?: IUriResolutionContext;
// if true, return value is a msgpack-encoded byte array encodeResult?: boolean;
// The wrapper to invoke wrapper: Wrapper }
A Promise with a Result containing the return value or an error
Resolve a URI to a wrap package or wrapper. If the URI resolves to wrap package, load the wrapper.
the Uri to resolve
Optional resolutionContext: IUriResolutionContextOptional options: DeserializeManifestOptions{ noValidate?: boolean }
A Promise with a Result containing a Wrapper or Error
Unlike other methods, loadWrapper does not accept a string URI.
You can create a Uri (from the @polywrap/core-js package) using Uri.from("wrap://...")
Resolve a URI to a wrap package, a wrapper, or a uri
{ uri: TUri; resolutionContext?: IUriResolutionContext }
A Promise with a Result containing either a wrap package, a wrapper, or a URI if successful
Validate a wrapper, given a URI. Optionally, validate the full ABI and/or recursively validate imports.
the Uri to resolve
{ abi?: boolean; recursive?: boolean }
A Promise with a Result containing a boolean or Error
Generated using TypeDoc
CoreClient invokes wrappers and interacts with wrap packages.