Skip to content
This repository was archived by the owner on Feb 26, 2024. It is now read-only.

Commit 0a2d081

Browse files
committed
Add note about getSupportedNetworks
1 parent 341a7f5 commit 0a2d081

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

packages/fetch-and-compile/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ export interface FetchAndCompileOptions {
124124

125125
### `getSupportedNetworks`
126126

127-
If you want a list of supported networks, you can call `getSupportedNetworks`:
127+
If you want a (potentially partial) list of supported networks, you can call `getSupportedNetworks`:
128128

129129
```ts
130130
import { getSupportedNetworks } from "@truffle/fetch-and-compile";
@@ -140,6 +140,8 @@ const networks = getSupportedNetworks();
140140
// }
141141
```
142142

143+
Note that there may be additional unlisted supported networks.
144+
143145
You can also pass in a list of fetchers if you want to restrict the output to the networks
144146
supported by the fetchers you list. (You can also pass in a config and it will use the `sourceFetchers`
145147
property if set, or a `FetchAndCompileOptions` and it will use the `fetch.precedence` field if set.)

0 commit comments

Comments
 (0)