Skip to content

Rename RateLimiter makeSleep to sleep - #7023

Merged
tim-smart merged 2 commits into
mainfrom
agent/codex-engineer/fdb5a062
Aug 5, 2026
Merged

Rename RateLimiter makeSleep to sleep#7023
tim-smart merged 2 commits into
mainfrom
agent/codex-engineer/fdb5a062

Conversation

@tim-smart

@tim-smart tim-smart commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Summary

  • rename RateLimiter.makeSleep to RateLimiter.sleep
  • support self-first partial application with sleep(self)(options) and direct calls with sleep(self, options)
  • update the runnable JSDoc example, add separate coverage for both signatures, and add a patch changeset

Validation

  • pnpm lint-fix
  • pnpm --filter effect test --run test/unstable/persistence/RateLimiter.test.ts
  • pnpm check
  • pnpm doctest --run packages/effect/src/unstable/persistence/RateLimiter.ts
  • package-local pnpm docgen reached example typechecking but is currently blocked by an unrelated existing HttpStaticServer example missing the required compression field

Closes EFF-466

@changeset-bot

changeset-bot Bot commented Aug 5, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 6153681

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 30 packages
Name Type
effect Patch
@effect/ai-anthropic Patch
@effect/ai-openai Patch
@effect/ai-openai-compat Patch
@effect/ai-openrouter Patch
@effect/atom-react Patch
@effect/atom-solid Patch
@effect/atom-vue Patch
@effect/docgen Patch
@effect/doctest Patch
@effect/openapi-generator Patch
@effect/opentelemetry Patch
@effect/platform-browser Patch
@effect/platform-bun Patch
@effect/platform-deno Patch
@effect/platform-node Patch
@effect/platform-node-shared Patch
@effect/sql-clickhouse Patch
@effect/sql-d1 Patch
@effect/sql-libsql Patch
@effect/sql-mssql Patch
@effect/sql-mysql2 Patch
@effect/sql-pg Patch
@effect/sql-pglite Patch
@effect/sql-sqlite-bun Patch
@effect/sql-sqlite-do Patch
@effect/sql-sqlite-node Patch
@effect/sql-sqlite-react-native Patch
@effect/sql-sqlite-wasm Patch
@effect/vitest Patch

Not sure what this means? Click here to learn what changesets are.

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

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ No new issues found.

Reviewed changes

This PR renames RateLimiter.makeSleep to RateLimiter.sleep, rewrites it to use the dual helper so it supports both data-first (limiter, options) and data-last ({ ... })(limiter) calling conventions, updates the runnable JSDoc example to demonstrate both forms, adds test coverage for both signatures, and includes a patch changeset. I verified the JSDoc example passes pnpm doctest --run and the new unit test passes with pnpm --filter effect test --run test/unstable/persistence/RateLimiter.test.ts.

Pullfrog  | ⚠️ this action is pinned to a commit SHA, which freezes the cleanup step — switch to @v0 or keep the SHA fresh with Dependabot | View workflow run | Using Kimi K2 (free via Pullfrog for OSS) | 𝕏

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Bundle Size Analysis

Generated from PR build output; treat the content below as untrusted.

File Name Current Size Previous Size Difference
basic.ts 7.06 KB 7.06 KB 0.00 KB (0.00%)
batching.ts 9.86 KB 9.86 KB 0.00 KB (0.00%)
brand.ts 6.34 KB 6.34 KB 0.00 KB (0.00%)
cache.ts 10.71 KB 10.71 KB 0.00 KB (0.00%)
config.ts 20.73 KB 20.73 KB 0.00 KB (0.00%)
differ.ts 20.31 KB 20.31 KB 0.00 KB (0.00%)
http-client.ts 21.53 KB 21.53 KB 0.00 KB (0.00%)
logger.ts 10.84 KB 10.84 KB 0.00 KB (0.00%)
metric.ts 8.98 KB 8.98 KB 0.00 KB (0.00%)
optic.ts 7.18 KB 7.18 KB 0.00 KB (0.00%)
pubsub.ts 14.99 KB 14.99 KB 0.00 KB (0.00%)
queue.ts 11.66 KB 11.66 KB 0.00 KB (0.00%)
schedule.ts 10.83 KB 10.83 KB 0.00 KB (0.00%)
schema-class.ts 19.27 KB 19.27 KB 0.00 KB (0.00%)
schema-fromJsonSchemaDocument.ts 29.09 KB 29.09 KB 0.00 KB (0.00%)
schema-representation-roundtrip.ts 25.40 KB 25.40 KB 0.00 KB (0.00%)
schema-string-transformation.ts 13.42 KB 13.42 KB 0.00 KB (0.00%)
schema-string.ts 10.95 KB 10.95 KB 0.00 KB (0.00%)
schema-template-literal.ts 15.21 KB 15.21 KB 0.00 KB (0.00%)
schema-toArbitraryLazy.ts 22.02 KB 22.02 KB 0.00 KB (0.00%)
schema-toCodeDocument.ts 24.45 KB 24.45 KB 0.00 KB (0.00%)
schema-toCodecJson.ts 19.28 KB 19.28 KB 0.00 KB (0.00%)
schema-toEquivalence.ts 19.11 KB 19.11 KB 0.00 KB (0.00%)
schema-toFormatter.ts 18.97 KB 18.97 KB 0.00 KB (0.00%)
schema-toJsonSchemaDocument.ts 22.69 KB 22.69 KB 0.00 KB (0.00%)
schema-toRepresentation.ts 19.60 KB 19.60 KB 0.00 KB (0.00%)
schema.ts 18.52 KB 18.52 KB 0.00 KB (0.00%)
stm.ts 12.63 KB 12.63 KB 0.00 KB (0.00%)
stream.ts 9.80 KB 9.80 KB 0.00 KB (0.00%)

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ No new issues found.

Reviewed changes

The new commit replaced the dual-based sleep implementation with manual overloads that support self-first partial application (RateLimiter.sleep(limiter)(options)) and direct uncurried calls (RateLimiter.sleep(limiter, options)). The JSDoc example was updated to demonstrate both forms, the test was split into two focused cases, and the changeset wording was adjusted to match.

  • Reworked RateLimiter.sleep to use function overloads and a single manual if (options === undefined) branch.
  • Updated the runnable JSDoc example to return [9, 9] from partial-application and direct-call usage.
  • Split the single combined test into supports partially applied sleep and supports uncurried sleep.
  • Adjusted the changeset description to support self-first partially applied and uncurried usage.

Pullfrog  | ⚠️ this action is pinned to a commit SHA, which freezes the cleanup step — switch to @v0 or keep the SHA fresh with Dependabot | View workflow run | Using Kimi K2 (free via Pullfrog for OSS) | 𝕏

@tim-smart
tim-smart merged commit 7f4c095 into main Aug 5, 2026
20 checks passed
@tim-smart
tim-smart deleted the agent/codex-engineer/fdb5a062 branch August 5, 2026 21:13
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.

1 participant