andywer / andywer/threads.js

Question: unusable sample code

Open
#400 1 comment 1 reaction 0 assignees View on GitHub
documentation question
Dominant language
TypeScript
Stars
3.5k
Forks
173
PR merge metrics
No merged PRs in 30d

Description

I'm doing some usage of your package, with TypeScript.

I see [in your documentation](https://threads.js.org/usage-pool#scheduling-tasks) an example that shows:

`let pool: Pool`

Well, perhaps I'm missing something, but `ThreadType` is not exposed it seems (or, it's hidden somewhere)? Or, is this supposed to be a placeholder for something else?

I want to declare (with type information) a variable like what you've shown, but, like I said, it seems `ThreadType` is not exposed.

What's supposed to be used here?

Another issue is that when I do something like this:

```ts
const x = Pool(spawnWorker, 1);
```

VSCode is able to show me that `x` has been attributed a type of:

```
const x: WorkerPool>
```

But, again, it seems I am not able to import all of these discreet types :(

What I really want to be able to do is say that I have an object having a variable/as yet unknown number of (referenced by string key) `Pool(()=> spawn(new Worker('./worker')), 1)` results.

eg:
```ts
const spawnWorker = () => spawn(new Worker('./worker'));

const pools: {
[index: string]: WorkerPool>;
} = {};
```

so I can add to my `pools` like this:

```ts
pools['thing1'] = Pool(spawnWorker, 1);
```

But, again, `WorkerPool` and `Result` do not appear to be exposed.

A little help please?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.