Skip to content

Conversation

@IMax153
Copy link
Member

@IMax153 IMax153 commented Dec 17, 2025

Type

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

Description

Related

@IMax153 IMax153 requested a review from tim-smart December 17, 2025 21:41
@IMax153
Copy link
Member Author

IMax153 commented Dec 17, 2025

@tim-smart - not sure if there's a better way to do the above check to avoid instanceof (#831)

@github-actions
Copy link

📊 JSDoc Documentation Analysis

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

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

📊 SUMMARY STATISTICS
------------------------------
Total files analyzed: 122
Total exported members: 3923
Missing @example: 1555 (39.6%)
Missing @category: 496 (12.6%)

🎯 TOP FILES NEEDING ATTENTION
----------------------------------------
1. Schema.ts
   📝 465 missing examples, 🏷️  271 missing categories
   📦 465 total exports
2. SchemaStandard.ts
   📝 75 missing examples, 🏷️  74 missing categories
   📦 75 total exports
3. Stream.ts
   📝 134 missing examples, 🏷️  0 missing categories
   📦 223 total exports
4. SchemaAST.ts
   📝 77 missing examples, 🏷️  18 missing categories
   📦 77 total exports
5. Channel.ts
   📝 70 missing examples, 🏷️  0 missing categories
   📦 139 total exports
6. SchemaGetter.ts
   📝 49 missing examples, 🏷️  0 missing categories
   📦 49 total exports
7. SchemaTransformation.ts
   📝 29 missing examples, 🏷️  18 missing categories
   📦 29 total exports
8. Config.ts
   📝 33 missing examples, 🏷️  5 missing categories
   📦 33 total exports
9. Sink.ts
   📝 33 missing examples, 🏷️  0 missing categories
   📦 50 total exports
10. Effect.ts
   📝 29 missing examples, 🏷️  1 missing categories
   📦 232 total exports
11. Cause.ts
   📝 26 missing examples, 🏷️  2 missing categories
   📦 66 total exports
12. SchemaFromJson.ts
   📝 12 missing examples, 🏷️  12 missing categories
   📦 12 total exports
13. SchemaIssue.ts
   📝 22 missing examples, 🏷️  2 missing categories
   📦 22 total exports
14. SchemaParser.ts
   📝 24 missing examples, 🏷️  0 missing categories
   📦 24 total exports
15. SynchronizedRef.ts
   📝 24 missing examples, 🏷️  0 missing categories
   📦 24 total exports

✅ PERFECTLY DOCUMENTED FILES
-----------------------------------
   Chunk.ts (87 exports)
   Clock.ts (5 exports)
   Console.ts (21 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)
   Match.ts (57 exports)
   MutableHashSet.ts (9 exports)
   MutableRef.ts (17 exports)
   NonEmptyIterable.ts (3 exports)
   Random.ts (7 exports)
   Redacted.ts (9 exports)
   RegExp.ts (3 exports)
   Runtime.ts (3 exports)
   Symbol.ts (1 exports)
   Trie.ts (29 exports)
   TxChunk.ts (22 exports)
   TxHashMap.ts (41 exports)
   TxHashSet.ts (24 exports)
   TxRef.ts (7 exports)
   TxSemaphore.ts (14 exports)
   Unify.ts (8 exports)
   index.ts (0 exports)

🔍 SAMPLE MISSING ITEMS FROM Schema.ts
-----------------------------------
   Optionality (type, line 53): missing example, category
   Mutability (type, line 60): missing example, category
   ConstructorDefault (type, line 67): missing example, category
   MakeOptions (interface, line 75): missing example, category
   Bottom (interface, line 99): missing example, category
   declareConstructor (interface, line 179): missing example, category
   declareConstructor (function, line 203): missing example
   declare (interface, line 227): missing example
   declare (function, line 236): missing example, category
   revealBottom (function, line 256): missing example, category

📋 BREAKDOWN BY EXPORT TYPE
-----------------------------------
const: 741 missing examples, 146 missing categories
function: 296 missing examples, 99 missing categories
type: 166 missing examples, 84 missing categories
interface: 262 missing examples, 147 missing categories
class: 56 missing examples, 1 missing categories
namespace: 34 missing examples, 19 missing categories

📈 DOCUMENTATION PROGRESS
------------------------------
Examples: 2368/3923 (60.4% complete)
Categories: 3427/3923 (87.4% complete)

============================================================
Analysis complete! 2051 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

Bundle Size Analysis

File Name Current Size Previous Size Difference
bundle/basic.ts 6.23 KB 6.23 KB 0.00 KB (0.00%)
bundle/batching.ts 8.49 KB 8.49 KB 0.00 KB (0.00%)
bundle/brand.ts 6.30 KB 6.30 KB 0.00 KB (0.00%)
bundle/cache.ts 9.55 KB 9.55 KB 0.00 KB (0.00%)
bundle/config.ts 16.07 KB 16.07 KB 0.00 KB (0.00%)
bundle/differ.ts 14.29 KB 14.29 KB 0.00 KB (0.00%)
bundle/http-client.ts 18.71 KB 18.71 KB 0.00 KB (0.00%)
bundle/logger.ts 8.61 KB 8.61 KB 0.00 KB (0.00%)
bundle/metric.ts 8.72 KB 8.72 KB 0.00 KB (0.00%)
bundle/optic.ts 7.55 KB 7.55 KB 0.00 KB (0.00%)
bundle/pubsub.ts 13.06 KB 13.06 KB 0.00 KB (0.00%)
bundle/queue.ts 10.93 KB 10.93 KB 0.00 KB (0.00%)
bundle/schedule.ts 9.66 KB 9.66 KB 0.00 KB (0.00%)
bundle/schema-string-async.ts 11.29 KB 11.29 KB 0.00 KB (0.00%)
bundle/schema-string-check.ts 10.03 KB 10.03 KB 0.00 KB (0.00%)
bundle/schema-string.ts 9.62 KB 9.62 KB 0.00 KB (0.00%)
bundle/schema-template-literal.ts 12.19 KB 12.19 KB 0.00 KB (0.00%)
bundle/schema-toArbitraryLazy.ts 16.27 KB 16.27 KB 0.00 KB (0.00%)
bundle/schema-toCodecStringTree.ts 15.47 KB 15.47 KB 0.00 KB (0.00%)
bundle/schema-toEquivalence.ts 15.40 KB 15.40 KB 0.00 KB (0.00%)
bundle/schema-toFormatter.ts 15.26 KB 15.26 KB 0.00 KB (0.00%)
bundle/schema-toJsonSchema.ts 16.56 KB 16.56 KB 0.00 KB (0.00%)
bundle/schema.ts 14.89 KB 14.89 KB 0.00 KB (0.00%)
bundle/standard-roundtrip.ts 22.97 KB 22.97 KB 0.00 KB (0.00%)
bundle/stm.ts 11.72 KB 11.72 KB 0.00 KB (0.00%)
bundle/stream.ts 8.42 KB 8.42 KB 0.00 KB (0.00%)

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