Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Continues correcting JSDoc types for Typescript tooling compatibility #58

Merged
merged 4 commits into from
Jul 10, 2024
Merged

Continues correcting JSDoc types for Typescript tooling compatibility #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
756851d
corrects types: src/shared/iterate-emitter
ChrisC Jul 9, 2024
39f3ce7
enables type checking: src/shared/messages
ChrisC Jul 9, 2024
78c1c88
corrects types: src/shared/types
ChrisC Jul 9, 2024
66d3ed1
fixes EventEmitter import
ChrisC Jul 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions src/shared/iterate-emitter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
// @ts-nocheck
/**
* @module shared
*/

/**
* @param {EventEmitter} emitter
* @param {import("events").EventEmitter} emitter
* @param {string} nextEvent
* @param {string} [completeEvent]
* @param {string} [errorEvent]
Expand All @@ -13,7 +12,7 @@ export async function* iterateEmitter(emitter, nextEvent, completeEvent, errorEv
const values = [];
let open = true;
let error = null;
let resolve = () => {};
let resolve = (_any = undefined) => {};
const onnext = function (value) {
if (open) {
values.push(value);
Expand Down
1 change: 0 additions & 1 deletion src/shared/messages.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
// @ts-nocheck
/// <reference path="./types.js" />

/**
Expand Down
7 changes: 3 additions & 4 deletions src/shared/types.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
// @ts-nocheck
/** @namespace AriaATCIShared */

/**
Expand Down Expand Up @@ -30,21 +29,21 @@
* Canceling the job will stop any loops of async iterables that have been
* wrapped with AriaATCIShared.JobBinding#cancelable.
*
* @template T
* @typedef AriaATCIShared.Job
* @property {function(): Promise<T>} cancel
* @template T
*/

/**
* @template T
* @typedef AriaATCIShared.JobBinding
* @property {function(AsyncIterable<T>): AsyncIterable<T>} cancelable finish
* the iterable if the job is canceled
* @template T
*/

/**
* @template T
* @callback AriaATCIShared.JobWork
* @param {AriaATCIShared.JobBinding<*>} binding
* @returns {Promise<T>}
* @template T
*/
Loading