Skip to content

Commit dbf6d74

Browse files
authored
docs: clarify NAPI limitations (#111)
1 parent ec78ce9 commit dbf6d74

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
> Piscina: A fast, efficient Node.js Worker Thread Pool implementation
44
5-
Tinypool is a fork of piscina. What we try to achieve in this library, is to eliminate some dependencies and features that our target users don't need (currently, our main user will be Vitest). Tinypool's install size (38KB) can then be smaller than Piscina's install size (6MB). If you need features like [utilization](https://github.com/piscinajs/piscina#property-utilization-readonly) or [NAPI](https://github.com/piscinajs/piscina#thread-priority-on-linux-systems), [Piscina](https://github.com/piscinajs/piscina) is a better choice for you. We think that Piscina is an amazing library, and we may try to upstream some of the dependencies optimization in this fork.
5+
Tinypool is a fork of piscina. What we try to achieve in this library, is to eliminate some dependencies and features that our target users don't need (currently, our main user will be Vitest). Tinypool's install size (38KB) can then be smaller than Piscina's install size (6MB). If you need features like [utilization](https://github.com/piscinajs/piscina#property-utilization-readonly) or OS-specific thread priority setting, [Piscina](https://github.com/piscinajs/piscina) is a better choice for you. We think that Piscina is an amazing library, and we may try to upstream some of the dependencies optimization in this fork.
66

77
- ✅ Smaller install size, 38KB
88
- ✅ Minimal
99
- ✅ No dependencies
1010
- ✅ Physical cores instead of Logical cores with [physical-cpu-count](https://www.npmjs.com/package/physical-cpu-count)
1111
- ✅ Supports `worker_threads` and `child_process`
1212
- ❌ No utilization
13-
- ❌ No NAPI
13+
- ❌ No OS-specific thread priority setting
1414

1515
- Written in TypeScript, and ESM support only. For Node.js 18.x and higher.
1616

0 commit comments

Comments
 (0)