Skip to content

docs: update JSDocs for Effect.callback and remove old option from NodeRuntime#1632

Merged
tim-smart merged 3 commits intoEffect-TS:mainfrom
f15u:federico/update-jsdocs
Mar 10, 2026
Merged

docs: update JSDocs for Effect.callback and remove old option from NodeRuntime#1632
tim-smart merged 3 commits intoEffect-TS:mainfrom
f15u:federico/update-jsdocs

Conversation

@f15u
Copy link
Copy Markdown
Contributor

@f15u f15u commented Mar 4, 2026

Type

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Description

Related

  • Related Issue #
  • Closes #

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Mar 4, 2026

⚠️ No Changeset found

Latest commit: 14ee763

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@f15u f15u force-pushed the federico/update-jsdocs branch from 054b77a to 14ee763 Compare March 4, 2026 15:30
@tim-smart tim-smart enabled auto-merge (squash) March 10, 2026 04:05
@tim-smart tim-smart merged commit 6bb8ec1 into Effect-TS:main Mar 10, 2026
15 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

📊 JSDoc Documentation Analysis

📈 Current Analysis Results
Analyzing 134 TypeScript files in packages/effect/src/ (including schema and config subdirectories)...

============================================================
         EFFECT JSDOC ANALYSIS REPORT
============================================================

📊 SUMMARY STATISTICS
------------------------------
Total files analyzed: 134
Total exported members: 4220
Missing @example: 2074 (49.1%)
Missing @category: 454 (10.8%)

🎯 TOP FILES NEEDING ATTENTION
----------------------------------------
1. Schema.ts
   📝 482 missing examples, 🏷️  268 missing categories
   📦 482 total exports
2. Array.ts
   📝 135 missing examples, 🏷️  2 missing categories
   📦 140 total exports
3. SchemaRepresentation.ts
   📝 96 missing examples, 🏷️  12 missing categories
   📦 96 total exports
4. SchemaAST.ts
   📝 77 missing examples, 🏷️  21 missing categories
   📦 77 total exports
5. Channel.ts
   📝 79 missing examples, 🏷️  0 missing categories
   📦 150 total exports
6. Cause.ts
   📝 75 missing examples, 🏷️  2 missing categories
   📦 75 total exports
7. Option.ts
   📝 66 missing examples, 🏷️  3 missing categories
   📦 66 total exports
8. Sink.ts
   📝 64 missing examples, 🏷️  2 missing categories
   📦 81 total exports
9. SchemaTransformation.ts
   📝 37 missing examples, 🏷️  26 missing categories
   📦 37 total exports
10. Predicate.ts
   📝 57 missing examples, 🏷️  0 missing categories
   📦 57 total exports
11. SchemaGetter.ts
   📝 49 missing examples, 🏷️  0 missing categories
   📦 49 total exports
12. Result.ts
   📝 46 missing examples, 🏷️  0 missing categories
   📦 46 total exports
13. Config.ts
   📝 34 missing examples, 🏷️  5 missing categories
   📦 34 total exports
14. Types.ts
   📝 39 missing examples, 🏷️  0 missing categories
   📦 39 total exports
15. Effect.ts
   📝 31 missing examples, 🏷️  2 missing categories
   📦 256 total exports

✅ PERFECTLY DOCUMENTED FILES
-----------------------------------
   Chunk.ts (86 exports)
   Clock.ts (5 exports)
   FiberHandle.ts (15 exports)
   FiberMap.ts (19 exports)
   FiberSet.ts (14 exports)
   HKT.ts (4 exports)
   HashMap.ts (44 exports)
   HashSet.ts (21 exports)
   Latch.ts (3 exports)
   Match.ts (57 exports)
   MutableHashSet.ts (9 exports)
   MutableRef.ts (17 exports)
   NonEmptyIterable.ts (3 exports)
   Random.ts (9 exports)
   Redacted.ts (9 exports)
   RegExp.ts (3 exports)
   Symbol.ts (1 exports)
   Trie.ts (29 exports)
   TxChunk.ts (22 exports)
   TxDeferred.ts (7 exports)
   TxHashMap.ts (41 exports)
   TxHashSet.ts (24 exports)
   TxPriorityQueue.ts (19 exports)
   TxReentrantLock.ts (18 exports)
   TxRef.ts (7 exports)
   TxSemaphore.ts (14 exports)
   TxSubscriptionRef.ts (12 exports)
   Unify.ts (8 exports)
   index.ts (0 exports)

🔍 SAMPLE MISSING ITEMS FROM Schema.ts
-----------------------------------
   Optionality (type, line 64): missing example, category
   Mutability (type, line 71): missing example, category
   ConstructorDefault (type, line 78): missing example, category
   MakeOptions (interface, line 86): missing example, category
   Bottom (interface, line 110): missing example, category
   declareConstructor (interface, line 163): missing example, category
   declareConstructor (function, line 187): missing example
   declare (interface, line 211): missing example
   declare (function, line 220): missing example, category
   revealBottom (function, line 240): missing example, category

📋 BREAKDOWN BY EXPORT TYPE
-----------------------------------
const: 1063 missing examples, 130 missing categories
interface: 319 missing examples, 132 missing categories
type: 240 missing examples, 74 missing categories
function: 345 missing examples, 97 missing categories
namespace: 48 missing examples, 20 missing categories
class: 59 missing examples, 1 missing categories

📈 DOCUMENTATION PROGRESS
------------------------------
Examples: 2146/4220 (50.9% complete)
Categories: 3766/4220 (89.2% complete)

============================================================
Analysis complete! 2528 items need attention.
============================================================

📄 Detailed results saved to: jsdoc-analysis-results.json

This comment is automatically updated on each push. View the analysis script for details.

@github-actions
Copy link
Copy Markdown
Contributor

Bundle Size Analysis

File Name Current Size Previous Size Difference
basic.ts 6.33 KB 6.37 KB -0.04 KB (-0.60%)
batching.ts 8.49 KB 8.53 KB -0.04 KB (-0.45%)
brand.ts 6.29 KB 6.29 KB 0.00 KB (0.00%)
cache.ts 9.64 KB 9.69 KB -0.04 KB (-0.42%)
config.ts 16.70 KB 16.73 KB -0.04 KB (-0.22%)
differ.ts 15.06 KB 15.09 KB -0.04 KB (-0.24%)
http-client.ts 19.09 KB 19.11 KB -0.02 KB (-0.10%)
logger.ts 8.82 KB 8.86 KB -0.04 KB (-0.44%)
metric.ts 8.19 KB 8.22 KB -0.03 KB (-0.41%)
optic.ts 7.54 KB 7.54 KB 0.00 KB (0.00%)
pubsub.ts 13.32 KB 13.36 KB -0.04 KB (-0.28%)
queue.ts 10.54 KB 10.57 KB -0.03 KB (-0.31%)
schedule.ts 9.93 KB 9.95 KB -0.02 KB (-0.24%)
schema-representation-roundtrip.ts 24.35 KB 24.40 KB -0.05 KB (-0.20%)
schema-string-transformation.ts 11.61 KB 11.65 KB -0.04 KB (-0.31%)
schema-string.ts 9.91 KB 9.94 KB -0.04 KB (-0.35%)
schema-template-literal.ts 12.52 KB 12.56 KB -0.04 KB (-0.32%)
schema-toArbitraryLazy.ts 16.75 KB 16.79 KB -0.04 KB (-0.23%)
schema-toCodeDocument.ts 19.43 KB 19.47 KB -0.04 KB (-0.19%)
schema-toCodecJson.ts 15.93 KB 15.96 KB -0.04 KB (-0.22%)
schema-toEquivalence.ts 15.90 KB 15.94 KB -0.04 KB (-0.26%)
schema-toFormatter.ts 15.75 KB 15.79 KB -0.04 KB (-0.25%)
schema-toJsonSchemaDocument.ts 18.18 KB 18.23 KB -0.04 KB (-0.22%)
schema-toRepresentation.ts 16.33 KB 16.35 KB -0.03 KB (-0.15%)
schema.ts 15.39 KB 15.42 KB -0.03 KB (-0.20%)
stm.ts 11.46 KB 11.49 KB -0.04 KB (-0.31%)
stream.ts 8.73 KB 8.77 KB -0.04 KB (-0.44%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants