@orkestrel/agent 0.0.15 → 0.0.17

package/dist/src/core/index.d.cts

@@ -1102,6 +1102,18 @@ export declare interface AuthorityRule {
  * `push` / `close` / `fail` enqueue/flag, then fire `#wake` so the parked reader wakes,
  * re-reads the buffer, and either yields the next chunk, returns (on `close`), or throws
  * (on `fail`). Event-free, no `!` / `as` / `any`.
+ *
+ * @example
+ * ```ts
+ * import { Channel } from '@orkestrel/agent'
+ *
+ * const channel = new Channel<number>()
+ * channel.push(1)
+ * channel.close()
+ * for await (const value of channel.drain()) {
+ * 	value // 1
+ * }
+ * ```
  */
 export declare class Channel<T> {
     #private;

package/dist/src/core/index.d.ts

@@ -1102,6 +1102,18 @@ export declare interface AuthorityRule {
  * `push` / `close` / `fail` enqueue/flag, then fire `#wake` so the parked reader wakes,
  * re-reads the buffer, and either yields the next chunk, returns (on `close`), or throws
  * (on `fail`). Event-free, no `!` / `as` / `any`.
+ *
+ * @example
+ * ```ts
+ * import { Channel } from '@orkestrel/agent'
+ *
+ * const channel = new Channel<number>()
+ * channel.push(1)
+ * channel.close()
+ * for await (const value of channel.drain()) {
+ * 	value // 1
+ * }
+ * ```
  */
 export declare class Channel<T> {
     #private;

package/dist/src/core/index.js

@@ -1287,6 +1287,18 @@ var AgentContext = class {
 * `push` / `close` / `fail` enqueue/flag, then fire `#wake` so the parked reader wakes,
 * re-reads the buffer, and either yields the next chunk, returns (on `close`), or throws
 * (on `fail`). Event-free, no `!` / `as` / `any`.
+*
+* @example
+* ```ts
+* import { Channel } from '@orkestrel/agent'
+*
+* const channel = new Channel<number>()
+* channel.push(1)
+* channel.close()
+* for await (const value of channel.drain()) {
+* 	value // 1
+* }
+* ```
 */
 var Channel = class {
 	#buffer = [];