Skip to content

Commit 9268493

Browse files
committed
Removed @internal jsdoc comments because we made symbols unique
1 parent e970715 commit 9268493

File tree

12 files changed

+20
-62
lines changed

12 files changed

+20
-62
lines changed

deno.jsonc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@
2525
// "noUnusedParameters": true,
2626
"checkJs": true,
2727
"lib": ["deno.window", "deno.worker" /*, "deno.unstable"*/]
28+
},
29+
"lint": {
30+
"rules": {
31+
"include": [],
32+
"exclude": ["no-explicit-any", "no-unused-vars"]
33+
}
2834
}
2935
// "unstable": ["raw-imports", "worker-options", "cron"]
3036
}

scripts/build.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,8 @@ await Deno.writeTextFile(
211211
try {
212212
await Deno.copyFile("LICENSE.md", path.join(OUT_DIR, "LICENSE.md"));
213213
await Deno.copyFile("README.md", path.join(OUT_DIR, "README.md"));
214-
} catch (e) {}
214+
} catch (e) {
215+
console.error(e);
216+
}
215217

216218
console.log("[Build] Success!");

src/lib/json_buffer.ts

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -510,8 +510,8 @@ class SharedJsonBufferImpl<T extends Proxyable> extends Serializable {
510510
if (ptr === 0) return undefined;
511511

512512
// Standard resolution
513-
let curr = ptr;
514-
let type = this._u32[curr >> 2]!;
513+
const curr = ptr;
514+
const type = this._u32[curr >> 2]!;
515515
if (type !== TYPE_MOVED) {
516516
this.s_len = this._u32[(curr + 8) >> 2]!;
517517
this.s_start = curr + 12;
@@ -1332,9 +1332,6 @@ class SharedJsonBufferImpl<T extends Proxyable> extends Serializable {
13321332
}
13331333
}
13341334

1335-
/**
1336-
* @internal
1337-
*/
13381335
[toSerialized]() {
13391336
return {
13401337
value: this.buffer,
@@ -1343,9 +1340,6 @@ class SharedJsonBufferImpl<T extends Proxyable> extends Serializable {
13431340
};
13441341
}
13451342

1346-
/**
1347-
* @internal
1348-
*/
13491343
static override [toDeserialized](
13501344
data: ReturnType<
13511345
SharedJsonBufferImpl<any>[typeof toSerialized]

src/lib/lib.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import { getCallerLocation } from "./caller_location.ts";
22
import { patchDynamicImports } from "./patch_import.ts";
33
import { WorkerPool } from "./pool.ts";
4-
import type { JoinHandle, Result, ThreadTask } from "./types.ts";
4+
import type { JoinHandle, Result, ThreadTask, UserFunction } from "./types.ts";
55
import { checkMoveArgs } from "./check_move_args.ts";
66

77
export * from "./sync/mod.ts";
88
export { SharedJsonBuffer } from "./json_buffer.ts";
99

1010
let globalPool: WorkerPool | null = null;
11-
const functionIdCache = new WeakMap<Function, string>();
11+
const functionIdCache = new WeakMap<UserFunction, string>();
1212
let globalConfig = { maxWorkers: navigator.hardwareConcurrency || 4 };
1313

1414
export function initRuntime(config: { maxWorkers: number }) {
@@ -64,7 +64,7 @@ export function spawn(arg1: any, arg2?: any): JoinHandle<any> {
6464
>();
6565

6666
let args: any[] = [];
67-
let fn: Function;
67+
let fn: UserFunction;
6868

6969
// Runtime Logic: Keeps checking for the Symbol
7070
if (arg1 && Object.prototype.hasOwnProperty.call(arg1, moveTag)) {

src/lib/sync/condvar.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,19 +70,13 @@ export class Condvar extends Serializable {
7070
Atomics.notify(this.#atomic, 0, Infinity);
7171
}
7272

73-
/**
74-
* @internal
75-
*/
7673
[toSerialized]() {
7774
return {
7875
value: this.#atomic.buffer,
7976
transfer: [],
8077
};
8178
}
8279

83-
/**
84-
* @internal
85-
*/
8680
static override [toDeserialized](
8781
obj: ReturnType<Condvar[typeof toSerialized]>["value"],
8882
) {

src/lib/sync/mpmc.ts

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,6 @@ class ChannelInternals<T> extends Serializable {
3737
super();
3838
}
3939

40-
/**
41-
* @internal
42-
*/
4340
[toSerialized]() {
4441
const itemsSer = serialize(this.items);
4542
const sendLockSer = serialize(this.sendLock);
@@ -208,9 +205,6 @@ export class Sender<T> extends Serializable implements Disposable {
208205
this.disposed = true;
209206
}
210207

211-
/**
212-
* @internal
213-
*/
214208
[toSerialized]() {
215209
if (this.disposed) {
216210
throw new Error("Cannot move a disposed Sender");
@@ -221,9 +215,6 @@ export class Sender<T> extends Serializable implements Disposable {
221215
return serialize(this.internals);
222216
}
223217

224-
/**
225-
* @internal
226-
*/
227218
static override [toDeserialized](
228219
obj: ReturnType<Sender<any>[typeof toSerialized]>["value"],
229220
) {
@@ -368,9 +359,6 @@ export class Receiver<T> extends Serializable implements Disposable {
368359
}
369360
}
370361

371-
/**
372-
* @internal
373-
*/
374362
[toSerialized]() {
375363
if (this.disposed) {
376364
throw new Error("Cannot move a disposed Receiver");
@@ -383,9 +371,6 @@ export class Receiver<T> extends Serializable implements Disposable {
383371
return serialize(this.internals);
384372
}
385373

386-
/**
387-
* @internal
388-
*/
389374
static override [toDeserialized](
390375
obj: ReturnType<Receiver<any>[typeof toSerialized]>["value"],
391376
) {

src/lib/sync/mutex.ts

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,6 @@ export class MutexGuard<T extends SharedMemoryView | void>
2525
implements Disposable {
2626
#data: T;
2727
#released = false;
28-
/**
29-
* @internal
30-
*/
3128
[INTERNAL_MUTEX_CONTROLLER]!: MutexController;
3229

3330
constructor(data: T, controller: MutexController) {
@@ -134,9 +131,6 @@ export class Mutex<T extends SharedMemoryView | void = void>
134131
return new MutexGuard(this.#data, this.#createController());
135132
}
136133

137-
/**
138-
* @internal
139-
*/
140134
[toSerialized]() {
141135
let serializedData;
142136
let transfer: Transferable[] = [];
@@ -156,9 +150,6 @@ export class Mutex<T extends SharedMemoryView | void = void>
156150
};
157151
}
158152

159-
/**
160-
* @internal
161-
*/
162153
static override [toDeserialized](
163154
obj: ReturnType<Mutex<any>[typeof toSerialized]>["value"],
164155
) {

src/lib/sync/rwlock.ts

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,6 @@ export class RwLockReadGuard<T extends SharedMemoryView | void>
2929
implements Disposable {
3030
#data: T;
3131
#released = false;
32-
/**
33-
* @internal
34-
*/
3532
[INTERNAL_RWLOCK_CONTROLLER]!: RwLockController;
3633

3734
constructor(data: T, controller: RwLockController) {
@@ -251,9 +248,6 @@ export class RwLock<T extends SharedMemoryView | void = void>
251248
}
252249
}
253250

254-
/**
255-
* @internal
256-
*/
257251
[toSerialized]() {
258252
let serializedData;
259253
let transfer: Transferable[] = [];
@@ -273,9 +267,6 @@ export class RwLock<T extends SharedMemoryView | void = void>
273267
};
274268
}
275269

276-
/**
277-
* @internal
278-
*/
279270
static override [toDeserialized](
280271
obj: ReturnType<RwLock<any>[typeof toSerialized]>["value"],
281272
) {

src/lib/sync/semaphore.ts

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,6 @@ export class Semaphore extends Serializable {
6565
* [1]: waiters (The number of threads currently waiting)
6666
*/
6767
#state: Int32Array<SharedArrayBuffer>;
68-
/**
69-
* @internal
70-
*/
7168
[INTERNAL_SEMAPHORE_CONTROLLER]!: SemaphoreController;
7269

7370
constructor(initialCount: number, _buffer?: SharedArrayBuffer) {
@@ -178,19 +175,13 @@ export class Semaphore extends Serializable {
178175
}
179176
}
180177

181-
/**
182-
* @internal
183-
*/
184178
[toSerialized]() {
185179
return {
186180
value: this.#state.buffer,
187181
transfer: [],
188182
};
189183
}
190184

191-
/**
192-
* @internal
193-
*/
194185
static override [toDeserialized](buffer: SharedArrayBuffer) {
195186
return new Semaphore(0, buffer);
196187
}

src/lib/types.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,7 @@ export type WorkerTaskPayload = {
5252
export type WorkerResponsePayload =
5353
| { type: "RESULT"; taskId: number; result: Envelope }
5454
| { type: "ERROR"; taskId: number; error: string; stack?: string };
55+
56+
export type UserFunction = (
57+
...args: unknown[]
58+
) => Promise<unknown> | unknown;

0 commit comments

Comments
 (0)