@zero-transfer/core 0.4.6 → 0.4.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +96 -99
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +1 -1
- package/dist/index.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,8 +8,6 @@
|
|
|
8
8
|
npm install @zero-transfer/core
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
This is the shared foundation used by every other `@zero-transfer/*` package. You usually do **not** install it directly - pick a protocol package (e.g. [`@zero-transfer/ftp`](https://www.npmjs.com/package/@zero-transfer/ftp)) or the umbrella [`@zero-transfer/sdk`](https://www.npmjs.com/package/@zero-transfer/sdk), and core comes along automatically.
|
|
12
|
-
|
|
13
11
|
## Overview
|
|
14
12
|
|
|
15
13
|
The provider-neutral foundation: `TransferClient`, `createTransferClient`, the provider registry, capability sets, transfer engine, queue, planning primitives, profile resolution, secret redaction, structured logging, and typed errors. Every other scoped package builds on this surface.
|
|
@@ -22,103 +20,102 @@ import { createLocalProviderFactory } from "@zero-transfer/core";
|
|
|
22
20
|
|
|
23
21
|
## Public surface
|
|
24
22
|
|
|
25
|
-
This package publishes a narrowed surface of **
|
|
26
|
-
|
|
27
|
-
| Symbol | Kind
|
|
28
|
-
| -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
29
|
-
| [`TransferClient`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/classes/TransferClient.md) | Class
|
|
30
|
-
| [`TransferClientOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/TransferClientOptions.md) | Interface
|
|
31
|
-
| [`createTransferClient`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createTransferClient.md) | Function
|
|
32
|
-
| [`ProviderRegistry`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/classes/ProviderRegistry.md) | Class
|
|
33
|
-
| [`TransferSession`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/TransferSession.md) | Interface
|
|
34
|
-
| [`TransferProvider`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/TransferProvider.md) | Interface
|
|
35
|
-
| `
|
|
36
|
-
| [`
|
|
37
|
-
| [`
|
|
38
|
-
| [`
|
|
39
|
-
| [`
|
|
40
|
-
| [`
|
|
41
|
-
| [`
|
|
42
|
-
| [`
|
|
43
|
-
| [`
|
|
44
|
-
| [`
|
|
45
|
-
| [`
|
|
46
|
-
| [`
|
|
47
|
-
| [`
|
|
48
|
-
| [`
|
|
49
|
-
| [`
|
|
50
|
-
| [`
|
|
51
|
-
| [`
|
|
52
|
-
| [`
|
|
53
|
-
| [`
|
|
54
|
-
| [`
|
|
55
|
-
| [`
|
|
56
|
-
| [`
|
|
57
|
-
| [`
|
|
58
|
-
| [`
|
|
59
|
-
| [`
|
|
60
|
-
| [`
|
|
61
|
-
| [`
|
|
62
|
-
| [`
|
|
63
|
-
| [`
|
|
64
|
-
| [`
|
|
65
|
-
| [`
|
|
66
|
-
| [`
|
|
67
|
-
| [`
|
|
68
|
-
| [`
|
|
69
|
-
| [`
|
|
70
|
-
| [`
|
|
71
|
-
| [`
|
|
72
|
-
| [`
|
|
73
|
-
| [`
|
|
74
|
-
| [`
|
|
75
|
-
| [`
|
|
76
|
-
| [`
|
|
77
|
-
| [`
|
|
78
|
-
| [`
|
|
79
|
-
| [`
|
|
80
|
-
| [`
|
|
81
|
-
| [`
|
|
82
|
-
| [`
|
|
83
|
-
| [`
|
|
84
|
-
| [`
|
|
85
|
-
| [`
|
|
86
|
-
| [`
|
|
87
|
-
| [`
|
|
88
|
-
| [`
|
|
89
|
-
| [`
|
|
90
|
-
| [`
|
|
91
|
-
| [`
|
|
92
|
-
| [`
|
|
93
|
-
| [`
|
|
94
|
-
| [`
|
|
95
|
-
| [`
|
|
96
|
-
| [`
|
|
97
|
-
| [`
|
|
98
|
-
| [`
|
|
99
|
-
| [`
|
|
100
|
-
| [`
|
|
101
|
-
| [`
|
|
102
|
-
| [`
|
|
103
|
-
| [`
|
|
104
|
-
| [`
|
|
105
|
-
| [`
|
|
106
|
-
| [`
|
|
107
|
-
| [`
|
|
108
|
-
| [`
|
|
109
|
-
| [`
|
|
110
|
-
| [`
|
|
111
|
-
| [`
|
|
112
|
-
| [`
|
|
113
|
-
| [`
|
|
114
|
-
| [`
|
|
115
|
-
| [`
|
|
116
|
-
| [`
|
|
117
|
-
| [`
|
|
118
|
-
| [`
|
|
119
|
-
| [`
|
|
120
|
-
| [`
|
|
121
|
-
| [`isMainModule`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/isMainModule.md) | Function | See API reference. |
|
|
23
|
+
This package publishes a narrowed surface of **92** exports. These symbols are also available from [`@zero-transfer/sdk`](https://www.npmjs.com/package/@zero-transfer/sdk); the table below links into the full API reference:
|
|
24
|
+
|
|
25
|
+
| Symbol | Kind | Notes |
|
|
26
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------ |
|
|
27
|
+
| [`TransferClient`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/classes/TransferClient.md) | Class | See API reference. |
|
|
28
|
+
| [`TransferClientOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/TransferClientOptions.md) | Interface | See API reference. |
|
|
29
|
+
| [`createTransferClient`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createTransferClient.md) | Function | See API reference. |
|
|
30
|
+
| [`ProviderRegistry`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/classes/ProviderRegistry.md) | Class | See API reference. |
|
|
31
|
+
| [`TransferSession`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/TransferSession.md) | Interface | See API reference. |
|
|
32
|
+
| [`TransferProvider`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/TransferProvider.md) | Interface | See API reference. |
|
|
33
|
+
| [`ProviderFactory`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/ProviderFactory.md) | Interface | See API reference. |
|
|
34
|
+
| [`ProviderTransferOperations`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/ProviderTransferOperations.md) | Interface | See API reference. |
|
|
35
|
+
| [`RemoteFileSystem`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/RemoteFileSystem.md) | Interface | See API reference. |
|
|
36
|
+
| [`CapabilitySet`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/CapabilitySet.md) | Interface | See API reference. |
|
|
37
|
+
| [`AuthenticationCapability`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/AuthenticationCapability.md) | Type | See API reference. |
|
|
38
|
+
| [`ChecksumCapability`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/ChecksumCapability.md) | Type | See API reference. |
|
|
39
|
+
| [`MetadataCapability`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/MetadataCapability.md) | Type | See API reference. |
|
|
40
|
+
| [`BuiltInProviderId`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/BuiltInProviderId.md) | Type | See API reference. |
|
|
41
|
+
| [`ProviderId`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/ProviderId.md) | Type | See API reference. |
|
|
42
|
+
| [`ProviderSelection`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/ProviderSelection.md) | Interface | See API reference. |
|
|
43
|
+
| [`TransferEngine`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/classes/TransferEngine.md) | Class | See API reference. |
|
|
44
|
+
| [`TransferQueue`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/classes/TransferQueue.md) | Class | See API reference. |
|
|
45
|
+
| [`TransferJob`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/TransferJob.md) | Interface | See API reference. |
|
|
46
|
+
| [`TransferPlan`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/TransferPlan.md) | Interface | See API reference. |
|
|
47
|
+
| [`TransferReceipt`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/TransferReceipt.md) | Interface | See API reference. |
|
|
48
|
+
| [`TransferEndpoint`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/TransferEndpoint.md) | Interface | See API reference. |
|
|
49
|
+
| [`TransferOperation`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/TransferOperation.md) | Type | See API reference. |
|
|
50
|
+
| [`TransferAttempt`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/TransferAttempt.md) | Interface | See API reference. |
|
|
51
|
+
| [`TransferRetryPolicy`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/TransferRetryPolicy.md) | Interface | See API reference. |
|
|
52
|
+
| [`TransferTimeoutPolicy`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/TransferTimeoutPolicy.md) | Interface | See API reference. |
|
|
53
|
+
| [`TransferBandwidthLimit`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/TransferBandwidthLimit.md) | Interface | See API reference. |
|
|
54
|
+
| [`TransferVerificationResult`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/TransferVerificationResult.md) | Interface | See API reference. |
|
|
55
|
+
| [`ProviderTransferSessionResolver`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/ProviderTransferSessionResolver.md) | Type | See API reference. |
|
|
56
|
+
| [`ProviderTransferSessionResolverInput`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/ProviderTransferSessionResolverInput.md) | Interface | See API reference. |
|
|
57
|
+
| [`createBandwidthThrottle`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createBandwidthThrottle.md) | Function | See API reference. |
|
|
58
|
+
| [`createProviderTransferExecutor`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createProviderTransferExecutor.md) | Function | See API reference. |
|
|
59
|
+
| [`createTransferJobsFromPlan`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createTransferJobsFromPlan.md) | Function | See API reference. |
|
|
60
|
+
| [`createTransferPlan`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createTransferPlan.md) | Function | See API reference. |
|
|
61
|
+
| [`summarizeTransferPlan`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/summarizeTransferPlan.md) | Function | See API reference. |
|
|
62
|
+
| [`throttleByteIterable`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/throttleByteIterable.md) | Function | See API reference. |
|
|
63
|
+
| [`copyBetween`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/copyBetween.md) | Function | See API reference. |
|
|
64
|
+
| [`uploadFile`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/uploadFile.md) | Function | See API reference. |
|
|
65
|
+
| [`downloadFile`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/downloadFile.md) | Function | See API reference. |
|
|
66
|
+
| [`CopyBetweenOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/CopyBetweenOptions.md) | Interface | See API reference. |
|
|
67
|
+
| [`UploadFileOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/UploadFileOptions.md) | Interface | See API reference. |
|
|
68
|
+
| [`DownloadFileOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/DownloadFileOptions.md) | Interface | See API reference. |
|
|
69
|
+
| [`FriendlyTransferOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/FriendlyTransferOptions.md) | Type | See API reference. |
|
|
70
|
+
| [`RemoteFileEndpoint`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/RemoteFileEndpoint.md) | Interface | See API reference. |
|
|
71
|
+
| [`runConnectionDiagnostics`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/runConnectionDiagnostics.md) | Function | See API reference. |
|
|
72
|
+
| [`summarizeClientDiagnostics`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/summarizeClientDiagnostics.md) | Function | See API reference. |
|
|
73
|
+
| [`ClientDiagnostics`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/ClientDiagnostics.md) | Interface | See API reference. |
|
|
74
|
+
| [`ConnectionDiagnosticsResult`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/ConnectionDiagnosticsResult.md) | Interface | See API reference. |
|
|
75
|
+
| [`ConnectionDiagnosticTimings`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/ConnectionDiagnosticTimings.md) | Interface | See API reference. |
|
|
76
|
+
| [`RunConnectionDiagnosticsOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/RunConnectionDiagnosticsOptions.md) | Interface | See API reference. |
|
|
77
|
+
| [`createLocalProviderFactory`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createLocalProviderFactory.md) | Function | See API reference. |
|
|
78
|
+
| [`LocalProviderOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/LocalProviderOptions.md) | Interface | See API reference. |
|
|
79
|
+
| [`createMemoryProviderFactory`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createMemoryProviderFactory.md) | Function | See API reference. |
|
|
80
|
+
| [`MemoryProviderOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/MemoryProviderOptions.md) | Interface | See API reference. |
|
|
81
|
+
| [`MemoryProviderEntry`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/MemoryProviderEntry.md) | Interface | See API reference. |
|
|
82
|
+
| [`createSyncPlan`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createSyncPlan.md) | Function | See API reference. |
|
|
83
|
+
| [`CreateSyncPlanOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/CreateSyncPlanOptions.md) | Interface | See API reference. |
|
|
84
|
+
| [`diffRemoteTrees`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/diffRemoteTrees.md) | Function | See API reference. |
|
|
85
|
+
| [`DiffRemoteTreesOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/DiffRemoteTreesOptions.md) | Interface | See API reference. |
|
|
86
|
+
| [`RemoteTreeDiff`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/RemoteTreeDiff.md) | Interface | See API reference. |
|
|
87
|
+
| [`RemoteTreeDiffEntry`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/RemoteTreeDiffEntry.md) | Interface | See API reference. |
|
|
88
|
+
| [`RemoteTreeDiffSummary`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/RemoteTreeDiffSummary.md) | Interface | See API reference. |
|
|
89
|
+
| [`createAtomicDeployPlan`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createAtomicDeployPlan.md) | Function | See API reference. |
|
|
90
|
+
| [`AtomicDeployPlan`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/AtomicDeployPlan.md) | Interface | See API reference. |
|
|
91
|
+
| [`AtomicDeployActivateStep`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/AtomicDeployActivateStep.md) | Interface | See API reference. |
|
|
92
|
+
| [`AtomicDeployActivateOperation`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/AtomicDeployActivateOperation.md) | Type | See API reference. |
|
|
93
|
+
| [`AtomicDeployPruneStep`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/AtomicDeployPruneStep.md) | Interface | See API reference. |
|
|
94
|
+
| [`AtomicDeployStrategy`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/AtomicDeployStrategy.md) | Type | See API reference. |
|
|
95
|
+
| [`CreateAtomicDeployPlanOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/CreateAtomicDeployPlanOptions.md) | Interface | See API reference. |
|
|
96
|
+
| [`walkRemoteTree`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/walkRemoteTree.md) | Function | See API reference. |
|
|
97
|
+
| [`WalkRemoteTreeOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/WalkRemoteTreeOptions.md) | Interface | See API reference. |
|
|
98
|
+
| [`createRemoteBrowser`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createRemoteBrowser.md) | Function | See API reference. |
|
|
99
|
+
| [`RemoteBrowser`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/RemoteBrowser.md) | Interface | See API reference. |
|
|
100
|
+
| [`RemoteBrowserSnapshot`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/RemoteBrowserSnapshot.md) | Interface | See API reference. |
|
|
101
|
+
| [`ConnectionProfile`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/ConnectionProfile.md) | Interface | See API reference. |
|
|
102
|
+
| [`RemoteEntry`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/RemoteEntry.md) | Interface | See API reference. |
|
|
103
|
+
| [`RemoteEntryType`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/RemoteEntryType.md) | Type | See API reference. |
|
|
104
|
+
| [`RemoteProtocol`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/RemoteProtocol.md) | Type | See API reference. |
|
|
105
|
+
| [`ListOptions`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/ListOptions.md) | Interface | See API reference. |
|
|
106
|
+
| [`validateConnectionProfile`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/validateConnectionProfile.md) | Function | See API reference. |
|
|
107
|
+
| [`resolveConnectionProfileSecrets`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/resolveConnectionProfileSecrets.md) | Function | See API reference. |
|
|
108
|
+
| [`redactConnectionProfile`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/redactConnectionProfile.md) | Function | See API reference. |
|
|
109
|
+
| [`redactSecretSource`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/redactSecretSource.md) | Function | See API reference. |
|
|
110
|
+
| [`resolveSecret`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/resolveSecret.md) | Function | See API reference. |
|
|
111
|
+
| [`createOAuthTokenSecretSource`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/createOAuthTokenSecretSource.md) | Function | See API reference. |
|
|
112
|
+
| [`ResolvedConnectionProfile`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/ResolvedConnectionProfile.md) | Interface | See API reference. |
|
|
113
|
+
| [`SecretSource`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/type-aliases/SecretSource.md) | Type | See API reference. |
|
|
114
|
+
| [`ZeroTransferError`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/classes/ZeroTransferError.md) | Class | See API reference. |
|
|
115
|
+
| [`ZeroTransferLogger`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/interfaces/ZeroTransferLogger.md) | Interface | See API reference. |
|
|
116
|
+
| [`noopLogger`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/variables/noopLogger.md) | Variable | See API reference. |
|
|
117
|
+
| [`emitLog`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/emitLog.md) | Function | See API reference. |
|
|
118
|
+
| [`isMainModule`](https://github.com/tonywied17/zero-transfer/blob/main/docs/api-md/functions/isMainModule.md) | Function | See API reference. |
|
|
122
119
|
|
|
123
120
|
## Examples
|
|
124
121
|
|