tornapi-typescript 0.1.5 → 0.2.0
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 +3 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
[](https://www.npmjs.com/package/tornapi-typescript)
|
|
4
4
|
[](https://www.npmjs.com/package/tornapi-typescript)
|
|
5
5
|
|
|
6
|
-
Automatically generated type definition in
|
|
6
|
+
Automatically generated type definition in TypeScript for [torn.com](https://torn.com) API V2.
|
|
7
7
|
|
|
8
8
|
## Installation
|
|
9
9
|
|
|
@@ -14,9 +14,7 @@ Automatically generated type definition in Typescript for [torn.com](https://tor
|
|
|
14
14
|
These types are generated in the following way:
|
|
15
15
|
|
|
16
16
|
* load [openapi specification](https://www.torn.com/swagger/openapi.json)
|
|
17
|
-
*
|
|
18
|
-
* remove `type` when `oneOf` is present, for improved types
|
|
19
|
-
* convert the specification to Typescript definitions using [typeconv](https://github.com/grantila/typeconv)
|
|
17
|
+
* convert the specification to TypeScript definitions using [typeconv](https://github.com/grantila/typeconv)
|
|
20
18
|
* clean the type definitions
|
|
21
19
|
* remove all "[key: string]: any;", because typeconv adds it everywhere for some reason
|
|
22
20
|
* remove all empty objects (caused by the above cleaning)
|
|
@@ -25,4 +23,4 @@ These types are generated in the following way:
|
|
|
25
23
|
## Contact
|
|
26
24
|
|
|
27
25
|
You can join the community in [our Discord server](https://discord.gg/2wb7GKN). There you can discuss anything related
|
|
28
|
-
to the Torn API
|
|
26
|
+
to the Torn API or other tools related to Torn. Issues can also be reported there, or as GitHub issue.
|