@xylabs/static-implements 5.0.95 → 5.0.97

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.
Files changed (2) hide show
  1. package/README.md +42 -79
  2. package/package.json +8 -11
package/README.md CHANGED
@@ -1,115 +1,78 @@
1
1
  # @xylabs/static-implements
2
2
 
3
- [![logo][]](https://xylabs.com)
3
+ [![npm][npm-badge]][npm-link]
4
+ [![license][license-badge]][license-link]
4
5
 
5
- [![main-build][]][main-build-link]
6
- [![npm-badge][]][npm-link]
7
- [![npm-downloads-badge][]][npm-link]
8
- [![jsdelivr-badge][]][jsdelivr-link]
9
- [![npm-license-badge][]](LICENSE)
10
- [![codacy-badge][]][codacy-link]
11
- [![codeclimate-badge][]][codeclimate-link]
12
- [![snyk-badge][]][snyk-link]
13
- [![socket-badge][]][socket-link]
6
+ > Base functionality used throughout XY Labs TypeScript/JavaScript libraries
14
7
 
8
+ ## Install
15
9
 
16
- Base functionality used throughout XY Labs TypeScript/JavaScript libraries
10
+ Using npm:
17
11
 
12
+ ```sh
13
+ npm install {{name}}
14
+ ```
18
15
 
16
+ Using yarn:
19
17
 
20
- ## Reference
21
-
22
- **@xylabs/static-implements**
23
-
24
- ***
25
-
26
- ## Functions
27
-
28
- | Function | Description |
29
- | ------ | ------ |
30
- | [staticImplements](#functions/staticImplements) | Annotation to decorate classes which implement static methods |
31
-
32
- ### functions
18
+ ```sh
19
+ yarn add {{name}}
20
+ ```
33
21
 
34
- ### <a id="staticImplements"></a>staticImplements
22
+ Using pnpm:
35
23
 
36
- [**@xylabs/static-implements**](#../README)
24
+ ```sh
25
+ pnpm add {{name}}
26
+ ```
37
27
 
38
- ***
28
+ Using bun:
39
29
 
40
- ```ts
41
- function staticImplements<T>(): <U>(constructor: U) => void;
30
+ ```sh
31
+ bun add {{name}}
42
32
  ```
43
33
 
44
- Annotation to decorate classes which implement static methods
45
34
 
46
- ## Type Parameters
47
-
48
- | Type Parameter |
49
- | ------ |
50
- | `T` |
35
+ ## License
51
36
 
52
- ## Returns
37
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
53
38
 
54
- The decorated class requiring it to implement
55
- the members of the the type as static properties/methods
39
+ ## Reference
56
40
 
57
- ```ts
58
- <U>(constructor: U): void;
59
- ```
41
+ ### packages
60
42
 
61
- ### Type Parameters
43
+ ### static-implements
62
44
 
63
- | Type Parameter |
64
- | ------ |
65
- | `U` |
45
+ ### .temp-typedoc
66
46
 
67
- ### Parameters
47
+ ### functions
68
48
 
69
- | Parameter | Type |
70
- | ------ | ------ |
71
- | `constructor` | `U` |
49
+ ### <a id="staticImplements"></a>staticImplements
72
50
 
73
- ### Returns
51
+ [**@xylabs/static-implements**](#../README)
74
52
 
75
- `void`
53
+ ***
76
54
 
55
+ ```ts
56
+ function staticImplements<T>(): <U>(constructor) => void;
57
+ ```
77
58
 
78
- Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
59
+ Annotation to decorate classes which implement static methods
79
60
 
80
- ## Maintainers
61
+ ## Type Parameters
81
62
 
82
- - [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
83
- - [Matt Jones](https://github.com/jonesmac)
84
- - [Joel Carter](https://github.com/JoelBCarter)
85
- - [Jordan Trouw](https://github.com/jordantrouw)
63
+ ### T
86
64
 
87
- ## License
65
+ `T`
88
66
 
89
- > See the [LICENSE](LICENSE) file for license details
67
+ ## Returns
90
68
 
91
- ## Credits
69
+ The decorated class requiring it to implement
70
+ the members of the the type as static properties/methods
92
71
 
93
- [Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
72
+ \<`U`\>(`constructor`) => `void`
94
73
 
95
- [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
96
74
 
97
- [main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
98
- [main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
99
75
  [npm-badge]: https://img.shields.io/npm/v/@xylabs/static-implements.svg
100
76
  [npm-link]: https://www.npmjs.com/package/@xylabs/static-implements
101
- [codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
102
- [codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
103
- [codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
104
- [codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
105
- [snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
106
- [snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
107
-
108
- [npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/static-implements
109
- [npm-license-badge]: https://img.shields.io/npm/l/@xylabs/static-implements
110
-
111
- [jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/static-implements/badge
112
- [jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/static-implements
113
-
114
- [socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/static-implements
115
- [socket-link]: https://socket.dev/npm/package/@xylabs/static-implements
77
+ [license-badge]: https://img.shields.io/npm/l/@xylabs/static-implements.svg
78
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/static-implements",
3
- "version": "5.0.95",
3
+ "version": "5.0.97",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "static",
@@ -30,12 +30,10 @@
30
30
  "exports": {
31
31
  ".": {
32
32
  "types": "./dist/neutral/index.d.ts",
33
- "import": "./dist/neutral/index.mjs",
34
33
  "default": "./dist/neutral/index.mjs"
35
34
  },
36
35
  "./package.json": "./package.json"
37
36
  },
38
- "types": "./dist/neutral/index.d.ts",
39
37
  "files": [
40
38
  "dist",
41
39
  "!**/*.bench.*",
@@ -44,17 +42,16 @@
44
42
  "README.md"
45
43
  ],
46
44
  "devDependencies": {
47
- "@types/node": "^25.5.2",
48
- "@xylabs/ts-scripts-common": "~7.8.4",
49
- "@xylabs/ts-scripts-pnpm": "~7.8.4",
50
- "@xylabs/tsconfig": "~7.8.4",
45
+ "@types/node": "^25.6.0",
46
+ "@xylabs/toolchain": "~7.10.4",
47
+ "@xylabs/tsconfig": "~7.10.4",
51
48
  "esbuild": "^0.28.0",
52
49
  "tslib": "^2.8.1",
53
50
  "typescript": "^5",
54
- "vite": "^8.0.5",
55
- "vitest": "^4.1.2",
56
- "@xylabs/vitest-matchers": "~5.0.95",
57
- "@xylabs/vitest-extended": "~5.0.95"
51
+ "vite": "^8.0.8",
52
+ "vitest": "^4.1.4",
53
+ "@xylabs/vitest-matchers": "~5.0.97",
54
+ "@xylabs/vitest-extended": "~5.0.97"
58
55
  },
59
56
  "engines": {
60
57
  "node": ">=18"