Skip to content

Commit

Permalink
chore: add TS @Satisfies check in jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
thinknathan committed Jul 9, 2024
1 parent c224a3f commit 5f38e1d
Show file tree
Hide file tree
Showing 33 changed files with 33 additions and 33 deletions.
2 changes: 1 addition & 1 deletion patches/_earlyChanges.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** Initial generic changes */
/** Initial generic changes @satisfies {(string | RegExp)[][]} */
export const earlyChanges = [
// Describe `url`
[
Expand Down
2 changes: 1 addition & 1 deletion patches/_finalChanges.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** Late changes that don't fit anywhere else */
/** Late changes that don't fit anywhere else @satisfies {(string | RegExp)[][]} */
export const finalChanges = [
// Replace `any` keyword with `unknown` in return values (greedy)
[/\): any/g, '): AnyNotNil | undefined'],
Expand Down
2 changes: 1 addition & 1 deletion patches/b2d.body.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** b2d.body namespace */
/** b2d.body namespace @satisfies {(string | RegExp)[][]} */
export const b2dBody = [
[
'function set_active(body: any, enable: any)',
Expand Down
2 changes: 1 addition & 1 deletion patches/b2d.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** b2d namespace */
/** b2d namespace @satisfies {(string | RegExp)[][]} */
export const b2d = [
[
'function get_body(url: string | hash | url): any',
Expand Down
2 changes: 1 addition & 1 deletion patches/buffer.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** buffer namespace */
/** buffer namespace @satisfies {(string | RegExp)[][]} */
export const bufferChanges = [
// (greedy)
[
Expand Down
2 changes: 1 addition & 1 deletion patches/camera.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** camera namespace */
/** camera namespace @satisfies {(string | RegExp)[][]} */
export const camera = [
['let aspect_ratio: any', 'let aspect_ratio: number'],
['let far_z: any', 'let far_z: number'],
Expand Down
2 changes: 1 addition & 1 deletion patches/collectionFactory.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** collectionFactory namespace */
/** collectionFactory namespace @satisfies {(string | RegExp)[][]} */
export const collectionFactory = [
// (greedy)
[
Expand Down
2 changes: 1 addition & 1 deletion patches/collectionProxy.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** collectionproxy namespace */
/** collectionproxy namespace @satisfies {(string | RegExp)[][]} */
export const collectionProxy = [
[
'function missing_resources(collectionproxy: url): any',
Expand Down
2 changes: 1 addition & 1 deletion patches/crash.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** crash namespace */
/** crash namespace @satisfies {(string | RegExp)[][]} */
export const crash = [
// (greedy)
[
Expand Down
2 changes: 1 addition & 1 deletion patches/factory.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** factory namespace */
/** factory namespace @satisfies {(string | RegExp)[][]} */
export const factory = [
// (greedy)
[
Expand Down
2 changes: 1 addition & 1 deletion patches/go.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** go namespace */
/** go namespace @satisfies {(string | RegExp)[][]} */
export const go = [
['let euler: any', 'let euler: vmath.vector3'],
['let position: any', 'let position: vmath.vector3'],
Expand Down
2 changes: 1 addition & 1 deletion patches/gui.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** gui namespace */
/** gui namespace @satisfies {(string | RegExp)[][]} */
export const gui = [
['let material: any', 'let material: hash'],
['let fonts: any', 'let fonts: hash'],
Expand Down
2 changes: 1 addition & 1 deletion patches/html5.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** html5 namespace */
/** html5 namespace @satisfies {(string | RegExp)[][]} */
export const html5 = [
[
'function set_interaction_listener(callback: any',
Expand Down
2 changes: 1 addition & 1 deletion patches/http.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** http namespace */
/** http namespace @satisfies {(string | RegExp)[][]} */
export const http = [
// function request
[
Expand Down
2 changes: 1 addition & 1 deletion patches/image.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** image namespace */
/** image namespace @satisfies {(string | RegExp)[][]} */
export const image = [
['let TYPE_LUMINANCE: any', 'const TYPE_LUMINANCE: "l"'],
['let TYPE_LUMINANCE_ALPHA: any', 'const TYPE_LUMINANCE_ALPHA: "la"'],
Expand Down
2 changes: 1 addition & 1 deletion patches/json.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** json namespace */
/** json namespace @satisfies {(string | RegExp)[][]} */
export const jsonChanges = [
['let null$: any', 'let null$: null'],
[
Expand Down
2 changes: 1 addition & 1 deletion patches/label.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** label namespace */
/** label namespace @satisfies {(string | RegExp)[][]} */
export const label = [
['let material: any', 'let material: hash'],
['let color: any', 'let color: vmath.vector4'],
Expand Down
2 changes: 1 addition & 1 deletion patches/model.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** model namespace */
/** model namespace @satisfies {(string | RegExp)[][]} */
export const model = [
['let material: any', 'let material: hash'],
['let playback_rate: any', 'let playback_rate: number'],
Expand Down
2 changes: 1 addition & 1 deletion patches/msg.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** msg namespace */
/** msg namespace @satisfies {(string | RegExp)[][]} */
export const msg = [
[
'export function post(receiver: string | url | hash, message_id: string | hash, message?: any): void',
Expand Down
2 changes: 1 addition & 1 deletion patches/particleFx.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** particlefx namespace */
/** particlefx namespace @satisfies {(string | RegExp)[][]} */
export const particleFx = [
// (greedy)
[
Expand Down
2 changes: 1 addition & 1 deletion patches/physics.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** physics namespace */
/** physics namespace @satisfies {(string | RegExp)[][]} */
export const physics = [
['let angular_damping: any', 'let angular_damping: number'],
['let angular_velocity: any', 'let angular_velocity: vmath.vector3'],
Expand Down
2 changes: 1 addition & 1 deletion patches/profiler.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** profiler namespace */
/** profiler namespace @satisfies {(string | RegExp)[][]} */
export const profiler = [
// (greedy)
[
Expand Down
2 changes: 1 addition & 1 deletion patches/render.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** render namespace */
/** render namespace @satisfies {(string | RegExp)[][]} */
export const render = [
// (greedy)
[
Expand Down
2 changes: 1 addition & 1 deletion patches/resource.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** resource namespace */
/** resource namespace @satisfies {(string | RegExp)[][]} */
export const resource = [
// (greedy)
[
Expand Down
2 changes: 1 addition & 1 deletion patches/socket.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** socket namespace */
/** socket namespace @satisfies {(string | RegExp)[][]} */
export const socket = [
['let _SETSIZE: any', 'const _SETSIZE: number'],
['let _VERSION: any', 'const _VERSION: string'],
Expand Down
2 changes: 1 addition & 1 deletion patches/sound.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** sound namespace */
/** sound namespace @satisfies {(string | RegExp)[][]} */
export const sound = [
['let sound: any', 'let sound: hash'],
['let gain: any', 'let gain: number'],
Expand Down
2 changes: 1 addition & 1 deletion patches/sprite.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** sprite namespace */
/** sprite namespace @satisfies {(string | RegExp)[][]} */
export const sprite = [
['let material: any', 'let material: hash'],
['let frame_count: any', 'const frame_count: number'],
Expand Down
2 changes: 1 addition & 1 deletion patches/sys.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** sys namespace */
/** sys namespace @satisfies {(string | RegExp)[][]} */
export const sys = [
// (greedy)
[
Expand Down
2 changes: 1 addition & 1 deletion patches/tilemap.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** tilemap namespace */
/** tilemap namespace @satisfies {(string | RegExp)[][]} */
export const tilemap = [
['let material: any', 'let material: hash'],
['let tile_source: any', 'let tile_source: hash'],
Expand Down
2 changes: 1 addition & 1 deletion patches/timer.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** timer namespace */
/** timer namespace @satisfies {(string | RegExp)[][]} */
export const timer = [
[
'let INVALID_TIMER_HANDLE: any',
Expand Down
2 changes: 1 addition & 1 deletion patches/vmath.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** vmath namespace */
/** vmath namespace @satisfies {(string | RegExp)[][]} */
export const vmathChanges = [
[
'function vector(t: any): any',
Expand Down
2 changes: 1 addition & 1 deletion patches/window.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @ts-check

/** window namespace */
/** window namespace @satisfies {(string | RegExp)[][]} */
export const windowChanges = [
// (greedy)
[
Expand Down
2 changes: 1 addition & 1 deletion patches/zlib.mjs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// @ts-check

/** zlib namespace */
/** zlib namespace @satisfies {(string | RegExp)[][]} */
export const zlib = [['', '']];

0 comments on commit 5f38e1d

Please sign in to comment.