You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/js/client/README.md
+86Lines changed: 86 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,6 +55,92 @@ Invoke a wrapper.
55
55
56
56
# Reference
57
57
58
+
## Configuration
59
+
60
+
Below you will find a reference of object definitions which can be used to configure the Polywrap client. Please note that the intended way of configuring the client is to use the `ClientConfigBuilder`, as explained above.
61
+
62
+
### ClientConfig
63
+
```ts
64
+
/**
65
+
* Client configuration that can be passed to the PolywrapClient
66
+
*
67
+
* @remarks
68
+
* The PolywrapClient converts the ClientConfig to a CoreClientConfig.
69
+
*/
70
+
exportinterfaceClientConfig {
71
+
/** set environmental variables for a wrapper */
72
+
readonly envs:Env[];
73
+
74
+
/** register interface implementations */
75
+
readonly interfaces:InterfaceImplementations[];
76
+
77
+
/** redirect invocations from one uri to another */
78
+
readonly redirects:IUriRedirect[];
79
+
80
+
/** add embedded wrappers */
81
+
readonly wrappers:IUriWrapper[];
82
+
83
+
/** add and configure embedded packages */
84
+
readonly packages:IUriPackage[];
85
+
86
+
/** customize URI resolution
87
+
*
88
+
* @remarks
89
+
* A UriResolverLike can be any one of:
90
+
* IUriResolver<unknown>
91
+
* | IUriRedirect
92
+
* | IUriPackage
93
+
* | IUriWrapper
94
+
* | UriResolverLike[]
95
+
* */
96
+
readonly resolvers:UriResolverLike[];
97
+
}
98
+
```
99
+
100
+
### PolywrapClientConfig
101
+
```ts
102
+
/**
103
+
* Client configuration that can be passed to the PolywrapClient.
104
+
*
105
+
* @remarks
106
+
* Extends ClientConfig from @polywrap/client-js.
107
+
* The PolywrapClient converts the PolywrapClientConfig to a CoreClientConfig.
Copy file name to clipboardExpand all lines: packages/js/client/readme/README.md
+14Lines changed: 14 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,6 +41,20 @@ $snippet: quickstart-invoke
41
41
42
42
# Reference
43
43
44
+
## Configuration
45
+
46
+
Below you will find a reference of object definitions which can be used to configure the Polywrap client. Please note that the intended way of configuring the client is to use the `ClientConfigBuilder`, as explained above.
0 commit comments