@statcord-ts/plugin-options 0.0.0-stage → 0.0.1-dev
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/LICENSE +19 -0
- package/README.md +22 -2
- package/dist/index.d.mts +40 -0
- package/dist/index.mjs +1 -0
- package/package.json +34 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
Copyright (c) 2026 Vorasion Development
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
4
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
5
|
+
in the Software without restriction, including without limitation the rights
|
|
6
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
7
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
8
|
+
furnished to do so, subject to the following conditions:
|
|
9
|
+
|
|
10
|
+
The above copyright notice and this permission notice shall be included in all
|
|
11
|
+
copies or substantial portions of the Software.
|
|
12
|
+
|
|
13
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
14
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
15
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
16
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
17
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
18
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
19
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,23 @@
|
|
|
1
|
-
#
|
|
1
|
+
# tsdown-starter
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A starter for creating a TypeScript package.
|
|
4
|
+
|
|
5
|
+
## Development
|
|
6
|
+
|
|
7
|
+
- Install dependencies:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
- Run the unit tests:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm run test
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
- Build the library:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm run build
|
|
23
|
+
```
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
//#region src/index.d.ts
|
|
2
|
+
export interface StatcordAutopostingOptions {
|
|
3
|
+
/**
|
|
4
|
+
* Whether autoposting is enabled. Defaults to false.
|
|
5
|
+
*/
|
|
6
|
+
enabled?: boolean;
|
|
7
|
+
/**
|
|
8
|
+
* The interval in milliseconds at which to autopost statistics. Defaults to 60000 (1 minute).
|
|
9
|
+
*/
|
|
10
|
+
interval?: number;
|
|
11
|
+
/**
|
|
12
|
+
* Whether to include CPU usage statistics, defaults to false.
|
|
13
|
+
*/
|
|
14
|
+
includeCpu?: boolean;
|
|
15
|
+
/**
|
|
16
|
+
* Whether to include RAM usage statistics, defaults to false.
|
|
17
|
+
*/
|
|
18
|
+
includeRam?: boolean;
|
|
19
|
+
}
|
|
20
|
+
export interface StatcordPluginOptions {
|
|
21
|
+
/**
|
|
22
|
+
* Your Statcord API key. Defaults to the core default (reading from STATCORD_API_KEY).
|
|
23
|
+
*/
|
|
24
|
+
apiKey?: string;
|
|
25
|
+
/**
|
|
26
|
+
* A boolean or an object specifying autoposting options. If a boolean, it indicates whether autoposting is enabled.
|
|
27
|
+
* If an object, it can contain more detailed autoposting settings.
|
|
28
|
+
* If only set to true, it includes everything it can acquire automatically.
|
|
29
|
+
*/
|
|
30
|
+
autopost?: boolean | StatcordAutopostingOptions;
|
|
31
|
+
/**
|
|
32
|
+
* The amount of milliseconds to await a response from Statcord. Defaults to the core default (30 seconds).
|
|
33
|
+
*/
|
|
34
|
+
httpTimeout?: number;
|
|
35
|
+
/**
|
|
36
|
+
* Whether to enable debug mode and log debug messages. Defaults to false.
|
|
37
|
+
*/
|
|
38
|
+
debug?: boolean;
|
|
39
|
+
}
|
|
40
|
+
//#endregion
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
package/package.json
CHANGED
|
@@ -1,6 +1,36 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@statcord-ts/plugin-options",
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.0.1-dev",
|
|
4
|
+
"description": "Options for the Statcord plugin, use if you want to make your own plugin.",
|
|
5
|
+
"homepage": "https://github.com/Vorasion-Development/statcord.ts#readme",
|
|
6
|
+
"bugs": {
|
|
7
|
+
"url": "https://github.com/Vorasion-Development/statcord.ts/issues"
|
|
8
|
+
},
|
|
9
|
+
"license": "MIT",
|
|
10
|
+
"author": "Vorasion Development",
|
|
11
|
+
"repository": {
|
|
12
|
+
"type": "git",
|
|
13
|
+
"url": "git+https://github.com/Vorasion-Development/statcord.ts.git"
|
|
14
|
+
},
|
|
15
|
+
"files": [
|
|
16
|
+
"dist",
|
|
17
|
+
"LICENSE",
|
|
18
|
+
"README.md",
|
|
19
|
+
"package.json"
|
|
20
|
+
],
|
|
21
|
+
"type": "module",
|
|
22
|
+
"exports": {
|
|
23
|
+
".": "./dist/index.mjs",
|
|
24
|
+
"./package.json": "./package.json"
|
|
25
|
+
},
|
|
26
|
+
"publishConfig": {
|
|
27
|
+
"access": "public"
|
|
28
|
+
},
|
|
29
|
+
"devDependencies": {
|
|
30
|
+
"@types/node": "^26.1.1",
|
|
31
|
+
"bumpp": "^11.1.0",
|
|
32
|
+
"tsdown": "^0.23.1",
|
|
33
|
+
"typescript": "^7.0.2",
|
|
34
|
+
"vitest": "^4.1.10"
|
|
35
|
+
}
|
|
36
|
+
}
|