minigame-std
Version:
Mini Game Standard Development Library.
79 lines (66 loc) • 5.13 kB
Markdown
**minigame-std**
***
# minigame-std
## Namespaces
| Namespace | Description |
| ------ | ------ |
| [audio](namespaces/audio/README.md) | - |
| [clipboard](namespaces/clipboard/README.md) | - |
| [cryptos](namespaces/cryptos/README.md) | - |
| [fs](namespaces/fs/README.md) | - |
| [image](namespaces/image/README.md) | - |
| [lbs](namespaces/lbs/README.md) | - |
| [platform](namespaces/platform/README.md) | - |
| [storage](namespaces/storage/README.md) | - |
## Interfaces
| Interface | Description |
| ------ | ------ |
| [ISocket](interfaces/ISocket.md) | WebSocket 接口定义，描述了 WebSocket 的基本操作方法。 |
| [MinaFetchInit](interfaces/MinaFetchInit.md) | 微信小游戏网络请求初始化配置接口，继承自微信小游戏请求选项，除去'url'和'responseType'。 |
| [SocketListenerMap](interfaces/SocketListenerMap.md) | WebSocket 事件监听器映射接口，定义了与 WebSocket 事件对应的回调函数类型。 |
## Type Aliases
| Type alias | Description |
| ------ | ------ |
| [DataSource](type-aliases/DataSource.md) | The data source. |
| [FailType](type-aliases/FailType.md) | 类型工具：提取失败回调参数类型。 |
| [NetworkType](type-aliases/NetworkType.md) | 网络状态，混合了 web 和小游戏环境。 |
| [SocketOptions](type-aliases/SocketOptions.md) | 创建Socket的可选参数。 |
| [SuccessType](type-aliases/SuccessType.md) | 类型工具：提取成功回调参数类型。 |
| [UnionFetchInit](type-aliases/UnionFetchInit.md) | 联合网络请求初始化配置类型，结合了 FetchInit 和 MinaFetchInit。 |
| [ValidAPI](type-aliases/ValidAPI.md) | 类型工具：判断 API 是否符合 promisify 条件。 |
## Variables
| Variable | Description |
| ------ | ------ |
| [SocketReadyState](variables/SocketReadyState.md) | WebSocket 连接状态，小游戏环境可用。 |
## Functions
| Function | Description |
| ------ | ------ |
| [addErrorListener](functions/addErrorListener.md) | 添加错误监听器，用于监听标准的错误事件。 |
| [addNetworkChangeListener](functions/addNetworkChangeListener.md) | 监听网络状态变化。 |
| [addResizeListener](functions/addResizeListener.md) | 添加窗口大小变化监听器。 |
| [addUnhandledrejectionListener](functions/addUnhandledrejectionListener.md) | 添加未处理的 Promise 拒绝事件监听器。 |
| [assertSafeSocketUrl](functions/assertSafeSocketUrl.md) | 断言传入的 WebSocket URL 是否为 `wss` 协议。 |
| [assertSafeUrl](functions/assertSafeUrl.md) | 断言传入的 URL 是否为 `https` 协议。 |
| [assertString](functions/assertString.md) | 断言传入的是一个字符串。 |
| [base64FromBuffer](functions/base64FromBuffer.md) | Converts BufferSource into a base64 encoded string. |
| [base64ToBuffer](functions/base64ToBuffer.md) | Converts a base64 encoded string to an Uint8Array |
| [bufferSource2Ab](functions/bufferSource2Ab.md) | 将 BufferSource 转换为 ArrayBuffer。 |
| [bufferSource2U8a](functions/bufferSource2U8a.md) | 将 BufferSource 转换为 Uint8Array。 |
| [byteStringFromBuffer](functions/byteStringFromBuffer.md) | 将 Buffer 转换为 ByteString。 |
| [byteStringToBuffer](functions/byteStringToBuffer.md) | 将字符串转换为 Uint8Array。 |
| [connectSocket](functions/connectSocket.md) | 创建并返回一个 WebSocket 连接。 |
| [decodeBase64](functions/decodeBase64.md) | 将 Base64 格式的字符串数据解码。 |
| [encodeBase64](functions/encodeBase64.md) | 将字符串数据编码为 Base64 格式。 |
| [fetchT](functions/fetchT.md) | 发起一个网络请求，根据初始化配置返回对应类型的 FetchTask。 |
| [getNetworkType](functions/getNetworkType.md) | 获取网络状态。 |
| [hexFromBuffer](functions/hexFromBuffer.md) | 将 BufferSource 转换为十六进制字符串。 |
| [miniGameFailureToError](functions/miniGameFailureToError.md) | 将小游戏失败回调的结果转换为 `Error` 类型。 |
| [miniGameFailureToResult](functions/miniGameFailureToResult.md) | 将错误对象转换为 IOResult 类型。 |
| [promisifyWithResult](functions/promisifyWithResult.md) | 将小游戏异步 API 转换为返回 `AsyncResult<T, E>` 的新函数，需要转换的 API 必须是接受可选 `success` 和 `fail` 回调的函数，并且其返回值必须是 `void` 或 `Promise`。 |
| [textDecode](functions/textDecode.md) | 将二进制数据解码为字符串。 |
| [textEncode](functions/textEncode.md) | 将字符串数据编码为 `Uint8Array` |
| [toByteString](functions/toByteString.md) | 将 UTF-8 字符串转换为 ByteString。 |
| [tryDOMAsyncOp](functions/tryDOMAsyncOp.md) | 执行异步函数，预期异常都是 `DOMException`。 |
| [tryDOMSyncOp](functions/tryDOMSyncOp.md) | 执行同步函数，预期异常都是 `DOMException`。 |
| [tryGeneralAsyncOp](functions/tryGeneralAsyncOp.md) | 执行异步函数，预期异常都是 `WechatMinigame.GeneralCallbackResult`。 |
| [tryGeneralSyncOp](functions/tryGeneralSyncOp.md) | 执行同步函数，预期异常都是 `WechatMinigame.GeneralCallbackResult`。 |