@scml/addon-mod-time-wrapper 1.0.3 → 1.0.5
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 +52 -5
- package/package.json +5 -4
package/README.md
CHANGED
|
@@ -1,9 +1,56 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @scml/addon-mod-time-wrapper
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
TypeScript type definitions for Time wrapper addon.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add -D @scml/addon-mod-time-wrapper
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
### Main entry (global types)
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
/// <reference types="@scml/addon-mod-time-wrapper" />
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Main entry augments these global properties: `addonDoLTimeWrapperAddon` (instance of `DoLTimeWrapperAddon`).
|
|
20
|
+
|
|
21
|
+
### Subpath imports
|
|
4
22
|
|
|
5
|
-
|
|
23
|
+
```ts
|
|
24
|
+
import type { SomeType } from '@scml/addon-mod-time-wrapper/DoLTimeWrapperAddon';
|
|
25
|
+
```
|
|
6
26
|
|
|
7
|
-
|
|
27
|
+
## Exports
|
|
28
|
+
|
|
29
|
+
| Subpath | Description |
|
|
30
|
+
|--------|------|
|
|
31
|
+
| `.` | Main entry, augments Window/global |
|
|
32
|
+
| `./OldTimeFunctionHook` | Type declarations |
|
|
33
|
+
| `./TimeProxyManager` | Type declarations |
|
|
34
|
+
| `./DoLTimeWrapperAddonPlugin` | Type declarations |
|
|
35
|
+
| `./DoLTimeWrapperAddon` | Type declarations |
|
|
36
|
+
|
|
37
|
+
## Types
|
|
38
|
+
|
|
39
|
+
### Main entry
|
|
40
|
+
- **`addonDoLTimeWrapperAddon`** – Wraps DoL time-related functions; provides hooking and proxy for time APIs.
|
|
41
|
+
|
|
42
|
+
### `./DoLTimeWrapperAddon`
|
|
43
|
+
- **`DoLTimeWrapperAddon`** – Main addon class.
|
|
44
|
+
|
|
45
|
+
### `./DoLTimeWrapperAddonPlugin`
|
|
46
|
+
- Plugin interface for the time wrapper.
|
|
47
|
+
|
|
48
|
+
### `./OldTimeFunctionHook` / `./TimeProxyManager`
|
|
49
|
+
- **`OldTimeFunctionHook`** – Hook for original time functions.
|
|
50
|
+
- **`TimeProxyManager`** – Manages time function proxies.
|
|
51
|
+
|
|
52
|
+
## Type definition source
|
|
8
53
|
|
|
9
|
-
|
|
54
|
+
- Upstream: https://github.com/Lyoko-Jeremie/DoLTimeWrapperAddonMod
|
|
55
|
+
- Default branch: master
|
|
56
|
+
- Build: `pnpm run download && pnpm run build`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@scml/addon-mod-time-wrapper",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.5",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "SugarCube 2 Mod Loader Workspace",
|
|
6
6
|
"license": "MIT",
|
|
@@ -28,14 +28,15 @@
|
|
|
28
28
|
"./DoLTimeWrapperAddon": "./type-dist/DoLTimeWrapperAddon.d.ts"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@scml/sc2-modloader": "1.0.
|
|
31
|
+
"@scml/sc2-modloader": "1.0.5"
|
|
32
32
|
},
|
|
33
33
|
"devDependencies": {
|
|
34
|
-
"@scml/utils": "1.0.
|
|
34
|
+
"@scml/utils": "1.0.5"
|
|
35
35
|
},
|
|
36
36
|
"scripts": {
|
|
37
37
|
"download": "tsx src/download.ts",
|
|
38
38
|
"build": "tsdown && tsx src/after-build.ts",
|
|
39
|
-
"typecheck": "tsc --noEmit"
|
|
39
|
+
"typecheck": "tsc --noEmit",
|
|
40
|
+
"publint": "publint"
|
|
40
41
|
}
|
|
41
42
|
}
|