Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stuyk/typedef-exporter
A Type Definition Exporter for TypeScript. Extracts type info from .d.ts files.
https://github.com/stuyk/typedef-exporter
Last synced: about 22 hours ago
JSON representation
A Type Definition Exporter for TypeScript. Extracts type info from .d.ts files.
- Host: GitHub
- URL: https://github.com/stuyk/typedef-exporter
- Owner: Stuyk
- Created: 2022-09-14T00:55:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-14T01:40:26.000Z (over 2 years ago)
- Last Synced: 2024-05-01T16:36:23.908Z (8 months ago)
- Language: TypeScript
- Size: 94.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Typedef Exporter
This repository is to parse TypeDef files and extract specific information from them to help generate documentation.
It's very opinionated and not all TypeDef files may work for this program outright.
## Currently a Work In Progress. Stay Tuned.
**Example Output of Functions**
```json
[
{
"name": "getServerConfig",
"arguments": [],
"isExported": true,
"returnType": "IServerConfig"
},
{
"name": "getVehicleModelInfoByHash",
"arguments": [
{
"key": "vehicleHash",
"value": "number"
}
],
"isExported": true,
"returnType": "IVehicleModel"
},
{
"name": "getRemoteEventListeners",
"arguments": [
{
"key": "eventName",
"value": "string | null",
"comment": "eventName Name of the event or null for generic event."
}
],
"isExported": true,
"returnType": "((...args: any[]) => void)[]",
"comments": ""
},
{
"name": "stopResource",
"arguments": [
{
"key": "name",
"value": "string",
"comment": "name Name of the resource."
}
],
"isExported": true,
"returnType": "void",
"comments": "Stops the specified resource."
},
{
"name": "restartResource",
"arguments": [
{
"key": "name",
"value": "string",
"comment": "name Name of the resource."
}
],
"isExported": true,
"returnType": "void",
"comments": "Restarts the specified resource."
}
]
```