Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/waitingsong/node-win32-api
win32 api
https://github.com/waitingsong/node-win32-api
comctl32 electron esm ffi ffi-napi kernel32 koffi typescript user32 win32
Last synced: 3 months ago
JSON representation
win32 api
- Host: GitHub
- URL: https://github.com/waitingsong/node-win32-api
- Owner: waitingsong
- License: mit
- Created: 2017-10-18T13:14:10.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-07-07T14:40:06.000Z (4 months ago)
- Last Synced: 2024-07-07T15:28:54.501Z (4 months ago)
- Topics: comctl32, electron, esm, ffi, ffi-napi, kernel32, koffi, typescript, user32, win32
- Language: TypeScript
- Homepage:
- Size: 2.58 MB
- Stars: 408
- Watchers: 8
- Forks: 53
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - node-win32-api
README
# win32-api
FFI Definitions of Windows win32 api for [koffi]
[]()
[](https://opensource.org/licenses/MIT)
[](https://github.com/waitingsong/node-win32-api/actions)
[](https://codecov.io/gh/waitingsong/node-win32-api)
[](https://conventionalcommits.org)
[](https://lernajs.io/)
## Significant [Changes.V22]
Compile successfully with
- Node.js v18
- Node.js v20
- Node.js v22
## Migrate to v13
See [migrate13]
## Packages
| Package | Version |
| ------------- | ---------------------- |
| [`win32-api`] | [![main-svg]][main-ch] |
| [`win32-def`] | [![def-svg]][def-ch] |
## What can I do with this?
Calling win32 native functions come from user32.dll, kernel32.dll, comctl32.dll by Node.js via [node-ffi-napi]
## Installing
```sh
npm install win32-api
```
## Usage
### DLL Wrapper
- [User32](./src/util/user32/index.user32.ts)
- [Winspool](./src/util/winspool/index.winspool.ts)
```ts
import {
FindWindow,
GetDefaultPrinter,
} from 'win32-api/util'
// Retrieves the printer name of the default printer for the current user on the local computer
const printerName = await GetDefaultPrinter()
const child = spawn('notepad.exe')
const hWnd = await FindWindowEx(0, 0, 'Notepad', null)
```
## Demo
- [Demos](https://github.com/waitingsong/node-win32-api/blob/main/packages/win32-api/demo)
- [Tests](https://github.com/waitingsong/node-win32-api/blob/main/packages/win32-api/test)
## Relevant
- [Windows Api documentation](https://msdn.microsoft.com/en-us/library/windows/desktop/ff468919%28v=vs.85%29.aspx)
- [Windows Data Types](https://msdn.microsoft.com/en-us/library/windows/desktop/aa383751#DWORD)
- [System Error Codes](https://msdn.microsoft.com/en-us/library/windows/desktop/ms681381%28v=vs.85%29.aspx)
- [FFI doc](https://github.com/node-ffi/node-ffi/wiki/Node-FFI-Tutorial)
## License
[MIT](LICENSE)
### Languages
- [English](README.md)
- [中文](README.zh-CN.md)
[node-gyp]: https://github.com/nodejs/node-gyp
[windows-build-tools]: https://github.com/felixrieseberg/windows-build-tools
[node-gyp-on-windows]: https://github.com/nodejs/node-gyp#on-windows
[node-ffi-napi]: https://github.com/node-ffi-napi/node-ffi-napi
[node-ffi]: https://github.com/node-ffi/node-ffi
[`win32-api`]: https://github.com/waitingsong/node-win32-api/tree/main/packages/win32-api
[main-svg]: https://img.shields.io/npm/v/win32-api.svg?maxAge=86400
[main-ch]: https://github.com/waitingsong/node-win32-api/tree/main/packages/win32-api/CHANGELOG.md
[main-d-svg]: https://david-dm.org/waitingsong/node-win32-api.svg?path=packages/win32-api
[main-d-link]: https://david-dm.org/waitingsong/node-win32-api.svg?path=packages/win32-api
[main-dd-svg]: https://david-dm.org/waitingsong/node-win32-api/dev-status.svg?path=packages/win32-api
[main-dd-link]: https://david-dm.org/waitingsong/node-win32-api?path=packages/win32-api#info=devDependencies
[`win32-def`]: https://github.com/waitingsong/node-win32-api/tree/main/packages/win32-def
[def-svg]: https://img.shields.io/npm/v/win32-def.svg?maxAge=86400
[def-ch]: https://github.com/waitingsong/node-win32-api/tree/main/packages/win32-def/CHANGELOG.md
[def-d-svg]: https://david-dm.org/waitingsong/node-win32-api.svg?path=packages/win32-def
[def-d-link]: https://david-dm.org/waitingsong/node-win32-api.svg?path=packages/win32-def
[def-dd-svg]: https://david-dm.org/waitingsong/node-win32-api/dev-status.svg?path=packages/win32-def
[def-dd-link]: https://david-dm.org/waitingsong/node-win32-api?path=packages/win32-def#info=devDependencies
[koffi]: https://github.com/node-ffi-napi/node-ffi-napi/issues/269
[migrate13]: ./migrate13.md
[Changes.V22]: https://github.com/waitingsong/node-win32-api/CHANGES.v22.md