Skip to content

Commit 1ead7e8

Browse files
committed
docs: fix import paths in JSDoc examples
Correct package name from @socketsecurity/registry to @socketsecurity/lib in all @example blocks across utility modules.
1 parent aa028e7 commit 1ead7e8

5 files changed

Lines changed: 30 additions & 30 deletions

File tree

src/memoization.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ type CacheEntry<T> = {
4141
* @returns Memoized version of the function
4242
*
4343
* @example
44-
* import { memoize } from '@socketsecurity/registry/lib/memoization'
44+
* import { memoize } from '@socketsecurity/lib/memoization'
4545
*
4646
* const expensiveOperation = memoize((n: number) => {
4747
* // Heavy computation
@@ -130,7 +130,7 @@ export function memoize<Args extends unknown[], Result>(
130130
* @returns Memoized version of the async function
131131
*
132132
* @example
133-
* import { memoizeAsync } from '@socketsecurity/registry/lib/memoization'
133+
* import { memoizeAsync } from '@socketsecurity/lib/memoization'
134134
*
135135
* const fetchUser = memoizeAsync(async (id: string) => {
136136
* const response = await fetch(`/api/users/${id}`)
@@ -233,7 +233,7 @@ export function memoizeAsync<Args extends unknown[], Result>(
233233
* @returns Modified descriptor with memoized method
234234
*
235235
* @example
236-
* import { Memoize } from '@socketsecurity/registry/lib/memoization'
236+
* import { Memoize } from '@socketsecurity/lib/memoization'
237237
*
238238
* class Calculator {
239239
* @Memoize()
@@ -279,7 +279,7 @@ export function clearAllMemoizationCaches(): void {
279279
* @returns Memoized version using WeakMap
280280
*
281281
* @example
282-
* import { memoizeWeak } from '@socketsecurity/registry/lib/memoization'
282+
* import { memoizeWeak } from '@socketsecurity/lib/memoization'
283283
*
284284
* const processConfig = memoizeWeak((config: Config) => {
285285
* return expensiveTransform(config)
@@ -316,7 +316,7 @@ export function memoizeWeak<K extends object, Result>(
316316
* @returns Memoized version that only executes once
317317
*
318318
* @example
319-
* import { once } from '@socketsecurity/registry/lib/memoization'
319+
* import { once } from '@socketsecurity/lib/memoization'
320320
*
321321
* const initialize = once(() => {
322322
* console.log('Initializing…')
@@ -352,7 +352,7 @@ export function once<Result>(fn: () => Result): () => Result {
352352
* @returns Debounced memoized function
353353
*
354354
* @example
355-
* import { memoizeDebounced } from '@socketsecurity/registry/lib/memoization'
355+
* import { memoizeDebounced } from '@socketsecurity/lib/memoization'
356356
*
357357
* const search = memoizeDebounced(
358358
* (query: string) => performSearch(query),

src/performance.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ function isPerfEnabled(): boolean {
3636
* @returns Stop function that completes the timing
3737
*
3838
* @example
39-
* import { perfTimer } from '@socketsecurity/registry/lib/performance'
39+
* import { perfTimer } from '@socketsecurity/lib/performance'
4040
*
4141
* const stop = perfTimer('api-call')
4242
* await fetchData()
@@ -78,7 +78,7 @@ export function perfTimer(
7878
* @returns Result of the function and duration
7979
*
8080
* @example
81-
* import { measure } from '@socketsecurity/registry/lib/performance'
81+
* import { measure } from '@socketsecurity/lib/performance'
8282
*
8383
* const { result, duration } = await measure('fetch-packages', async () => {
8484
* return await fetchPackages()
@@ -116,7 +116,7 @@ export async function measure<T>(
116116
* @returns Result of the function and duration
117117
*
118118
* @example
119-
* import { measureSync } from '@socketsecurity/registry/lib/performance'
119+
* import { measureSync } from '@socketsecurity/lib/performance'
120120
*
121121
* const { result, duration } = measureSync('parse-json', () => {
122122
* return JSON.parse(data)
@@ -151,7 +151,7 @@ export function measureSync<T>(
151151
* @returns Array of performance metrics
152152
*
153153
* @example
154-
* import { getPerformanceMetrics } from '@socketsecurity/registry/lib/performance'
154+
* import { getPerformanceMetrics } from '@socketsecurity/lib/performance'
155155
*
156156
* const metrics = getPerformanceMetrics()
157157
* console.log(metrics)
@@ -164,7 +164,7 @@ export function getPerformanceMetrics(): PerformanceMetrics[] {
164164
* Clear all collected performance metrics.
165165
*
166166
* @example
167-
* import { clearPerformanceMetrics } from '@socketsecurity/registry/lib/performance'
167+
* import { clearPerformanceMetrics } from '@socketsecurity/lib/performance'
168168
*
169169
* clearPerformanceMetrics()
170170
*/
@@ -179,7 +179,7 @@ export function clearPerformanceMetrics(): void {
179179
* @returns Summary of metrics grouped by operation
180180
*
181181
* @example
182-
* import { getPerformanceSummary } from '@socketsecurity/registry/lib/performance'
182+
* import { getPerformanceSummary } from '@socketsecurity/lib/performance'
183183
*
184184
* const summary = getPerformanceSummary()
185185
* console.log(summary)
@@ -251,7 +251,7 @@ export function getPerformanceSummary(): Record<
251251
* Only prints when DEBUG=perf is enabled.
252252
*
253253
* @example
254-
* import { printPerformanceSummary } from '@socketsecurity/registry/lib/performance'
254+
* import { printPerformanceSummary } from '@socketsecurity/lib/performance'
255255
*
256256
* printPerformanceSummary()
257257
* // Performance Summary:
@@ -292,7 +292,7 @@ export function printPerformanceSummary(): void {
292292
* @param metadata - Optional metadata
293293
*
294294
* @example
295-
* import { perfCheckpoint } from '@socketsecurity/registry/lib/performance'
295+
* import { perfCheckpoint } from '@socketsecurity/lib/performance'
296296
*
297297
* perfCheckpoint('start-scan')
298298
* // ... do work ...
@@ -328,7 +328,7 @@ export function perfCheckpoint(
328328
* @returns Memory usage in MB
329329
*
330330
* @example
331-
* import { trackMemory } from '@socketsecurity/registry/lib/performance'
331+
* import { trackMemory } from '@socketsecurity/lib/performance'
332332
*
333333
* const memBefore = trackMemory('before-operation')
334334
* await heavyOperation()
@@ -368,7 +368,7 @@ export function trackMemory(label: string): number {
368368
* @returns Formatted performance report
369369
*
370370
* @example
371-
* import { generatePerformanceReport } from '@socketsecurity/registry/lib/performance'
371+
* import { generatePerformanceReport } from '@socketsecurity/lib/performance'
372372
*
373373
* console.log(generatePerformanceReport())
374374
* // ╔═══════════════════════════════════════════════╗

src/spinner.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ export type ShimmerInfo = ShimmerState & {
142142
*
143143
* @example
144144
* ```ts
145-
* import { Spinner } from '@socketsecurity/registry/lib/spinner'
145+
* import { Spinner } from '@socketsecurity/lib/spinner'
146146
*
147147
* const spinner = Spinner({ text: 'Loading…' })
148148
* spinner.start()
@@ -433,7 +433,7 @@ let _defaultSpinner: SpinnerStyle | undefined
433433
*
434434
* @example
435435
* ```ts
436-
* import { Spinner } from '@socketsecurity/registry/lib/spinner'
436+
* import { Spinner } from '@socketsecurity/lib/spinner'
437437
*
438438
* // Basic usage
439439
* const spinner = Spinner({ text: 'Loading data…' })
@@ -1307,7 +1307,7 @@ let _spinner: ReturnType<typeof Spinner> | undefined
13071307
*
13081308
* @example
13091309
* ```ts
1310-
* import { getDefaultSpinner } from '@socketsecurity/registry/lib/spinner'
1310+
* import { getDefaultSpinner } from '@socketsecurity/lib/spinner'
13111311
*
13121312
* const spinner = getDefaultSpinner()
13131313
* spinner.start('Loading…')
@@ -1328,11 +1328,11 @@ export function getDefaultSpinner(): ReturnType<typeof Spinner> {
13281328
* @example
13291329
* ```ts
13301330
* // Old (deprecated):
1331-
* import { spinner } from '@socketsecurity/registry/lib/spinner'
1331+
* import { spinner } from '@socketsecurity/lib/spinner'
13321332
* spinner.start('Loading…')
13331333
*
13341334
* // New (recommended):
1335-
* import { getDefaultSpinner } from '@socketsecurity/registry/lib/spinner'
1335+
* import { getDefaultSpinner } from '@socketsecurity/lib/spinner'
13361336
* const spinner = getDefaultSpinner()
13371337
* spinner.start('Loading…')
13381338
* ```
@@ -1382,7 +1382,7 @@ export type WithSpinnerOptions<T> = {
13821382
*
13831383
* @example
13841384
* ```ts
1385-
* import { Spinner, withSpinner } from '@socketsecurity/registry/lib/spinner'
1385+
* import { Spinner, withSpinner } from '@socketsecurity/lib/spinner'
13861386
*
13871387
* const spinner = Spinner()
13881388
*
@@ -1452,7 +1452,7 @@ export type WithSpinnerRestoreOptions<T> = {
14521452
*
14531453
* @example
14541454
* ```ts
1455-
* import { getDefaultSpinner, withSpinnerRestore } from '@socketsecurity/registry/lib/spinner'
1455+
* import { getDefaultSpinner, withSpinnerRestore } from '@socketsecurity/lib/spinner'
14561456
*
14571457
* const spinner = getDefaultSpinner()
14581458
* const wasSpinning = spinner.isSpinning
@@ -1517,7 +1517,7 @@ export type WithSpinnerSyncOptions<T> = {
15171517
*
15181518
* @example
15191519
* ```ts
1520-
* import { Spinner, withSpinnerSync } from '@socketsecurity/registry/lib/spinner'
1520+
* import { Spinner, withSpinnerSync } from '@socketsecurity/lib/spinner'
15211521
*
15221522
* const spinner = Spinner()
15231523
*

src/suppress-warnings.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ function setupSuppression(): void {
4848
* This is useful in tests or scripts where multiple listeners are expected.
4949
*
5050
* @example
51-
* import { suppressMaxListenersWarning } from '@socketsecurity/registry/lib/suppress-warnings'
51+
* import { suppressMaxListenersWarning } from '@socketsecurity/lib/suppress-warnings'
5252
*
5353
* suppressMaxListenersWarning()
5454
*/
@@ -63,7 +63,7 @@ export function suppressMaxListenersWarning(): void {
6363
* @param warningType - The warning type to suppress (e.g., 'DeprecationWarning', 'ExperimentalWarning')
6464
*
6565
* @example
66-
* import { suppressWarningType } from '@socketsecurity/registry/lib/suppress-warnings'
66+
* import { suppressWarningType } from '@socketsecurity/lib/suppress-warnings'
6767
*
6868
* suppressWarningType('ExperimentalWarning')
6969
*/
@@ -90,7 +90,7 @@ export function suppressWarningType(warningType: string): void {
9090
* @param maxListeners - Maximum number of listeners (defaults to 10, the Node.js default)
9191
*
9292
* @example
93-
* import { setMaxEventTargetListeners } from '@socketsecurity/registry/lib/suppress-warnings'
93+
* import { setMaxEventTargetListeners } from '@socketsecurity/lib/suppress-warnings'
9494
*
9595
* const controller = new AbortController()
9696
* setMaxEventTargetListeners(controller.signal)
@@ -133,7 +133,7 @@ export function restoreWarnings(): void {
133133
* @returns The result of the callback
134134
*
135135
* @example
136-
* import { withSuppressedWarnings } from '@socketsecurity/registry/lib/suppress-warnings'
136+
* import { withSuppressedWarnings } from '@socketsecurity/lib/suppress-warnings'
137137
*
138138
* const result = await withSuppressedWarnings('ExperimentalWarning', async () => {
139139
* // Code that triggers experimental warnings

src/tables.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ function padText(
5959
* @returns Formatted table string
6060
*
6161
* @example
62-
* import { formatTable } from '@socketsecurity/registry/lib/tables'
62+
* import { formatTable } from '@socketsecurity/lib/tables'
6363
* import colors from 'yoctocolors-cjs'
6464
*
6565
* const data = [
@@ -146,7 +146,7 @@ export function formatTable(
146146
* @returns Formatted table string
147147
*
148148
* @example
149-
* import { formatSimpleTable } from '@socketsecurity/registry/lib/tables'
149+
* import { formatSimpleTable } from '@socketsecurity/lib/tables'
150150
* import colors from 'yoctocolors-cjs'
151151
*
152152
* const data = [

0 commit comments

Comments
 (0)