https://github.com/bengsfort/irsdk-node
An iRacing SDK addon for Node.js, allowing you to use + control the iRacing SDK from Node.
https://github.com/bengsfort/irsdk-node
iracing iracing-api javascript node-addon nodejs sdk typescript
Last synced: 11 months ago
JSON representation
An iRacing SDK addon for Node.js, allowing you to use + control the iRacing SDK from Node.
- Host: GitHub
- URL: https://github.com/bengsfort/irsdk-node
- Owner: bengsfort
- Created: 2021-12-11T09:10:28.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-20T19:58:55.000Z (over 1 year ago)
- Last Synced: 2025-04-13T22:08:14.687Z (11 months ago)
- Topics: iracing, iracing-api, javascript, node-addon, nodejs, sdk, typescript
- Language: TypeScript
- Homepage:
- Size: 25.4 MB
- Stars: 18
- Watchers: 2
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @irsdk-node/workspace
This is the root of the `irsdk-node` workspace. `irsdk-node` is a node.js wrapper for the C++ iRacing SDK. It provides native bindings and a simple API to interact with it, allowing you to very easily consume data from the SDK or write apps to set up macros and other commands.
You can find the main module via the [irsdk-node](./packages/irsdk-node) package.
## Sub-packages
- [irsdk-node](./packages/irsdk-node): The main `irsdk-node` package.
- [@irsdk-node/types](./packages/irsdk-node-types): Package containing TypeScript implementations of the native types within the iRacing SDK.
- [@irsdk-node/native](./packages/irsdk-node-native): Package containing the native node.js addon that implements the bindings and interacts with the SDK. Consumed by `irsdk-node`.
## Updating packages
The packages in this repo are managed via yarn workspaces. We utilize the yarn workspaces and yarn version plugins to make this process much easier.
Use [`yarn version`](https://yarnpkg.com/cli/version) to version the different packages, preferrably in `--deferred` mode. You can use the interactive prompt to do this.
When ready to publish, just run `yarn publish` from the root and the script should take care of everything. Make sure to add a git tag after. Ideally this would be automated via github actions + changesets, but maybe in the future.