[skip ci] doc

Author: dhcmrlchtdj

doc/README.md

@@ -1,4 +1,4 @@
-**sync-op** • **Docs**
+**sync-op**
 
 ***
 

doc/classes/Channel.md

@@ -1,16 +1,20 @@
-[**sync-op**](../README.md) • **Docs**
+[**sync-op**](../README.md)
 
 ***
 
 [sync-op](../README.md) / Channel
 
 # Class: Channel\<T\>
 
+Defined in: [channel.ts:23](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/channel.ts#L23)
+
 the synchronous channel
 
 ## Type Parameters
 
-• **T**
+### T
+
+`T`
 
 ## Implements
 
@@ -19,9 +23,11 @@ the synchronous channel
 
 ## Constructors
 
-### new Channel()
+### Constructor
 
-> **new Channel**\<`T`\>(`capacity`): [`Channel`](Channel.md)\<`T`\>
+> **new Channel**\<`T`\>(`capacity`): `Channel`\<`T`\>
+
+Defined in: [channel.ts:38](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/channel.ts#L38)
 
 create a new channel with buffer size `capacity`
 
@@ -32,22 +38,22 @@ const buffered = new Channel(1)
 
 #### Parameters
 
-• **capacity**: `number` = `0`
+##### capacity
 
-#### Returns
+`number` = `0`
 
-[`Channel`](Channel.md)\<`T`\>
-
-#### Defined in
+#### Returns
 
-[channel.ts:38](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/channel.ts#L38)
+`Channel`\<`T`\>
 
 ## Methods
 
 ### \[asyncIterator\]()
 
 > **\[asyncIterator\]**(): `AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
 
+Defined in: [channel.ts:182](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/channel.ts#L182)
+
 ```typescript
 const ch = new Channel()
 ch.send(1)
@@ -63,18 +69,16 @@ for await (const msg of ch) {
 
 #### Implementation of
 
-[`readableChannel`](../interfaces/readableChannel.md).[`[asyncIterator]`](../interfaces/readableChannel.md#%5Basynciterator%5D)
-
-#### Defined in
-
-[channel.ts:182](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/channel.ts#L182)
+[`readableChannel`](../interfaces/readableChannel.md).[`[asyncIterator]`](../interfaces/readableChannel.md#asynciterator)
 
 ***
 
 ### close()
 
 > **close**(): `void`
 
+Defined in: [channel.ts:52](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/channel.ts#L52)
+
 #### Returns
 
 `void`
@@ -83,16 +87,14 @@ for await (const msg of ch) {
 
 [`writableChannel`](../interfaces/writableChannel.md).[`close`](../interfaces/writableChannel.md#close)
 
-#### Defined in
-
-[channel.ts:52](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/channel.ts#L52)
-
 ***
 
 ### isClosed()
 
 > **isClosed**(): `boolean`
 
+Defined in: [channel.ts:64](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/channel.ts#L64)
+
 #### Returns
 
 `boolean`
@@ -101,16 +103,14 @@ for await (const msg of ch) {
 
 [`writableChannel`](../interfaces/writableChannel.md).[`isClosed`](../interfaces/writableChannel.md#isclosed)
 
-#### Defined in
-
-[channel.ts:64](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/channel.ts#L64)
-
 ***
 
 ### isDrained()
 
 > **isDrained**(): `boolean`
 
+Defined in: [channel.ts:71](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/channel.ts#L71)
+
 returns `true` if the buffer is empty and there are no pending senders.
 
 #### Returns
@@ -121,16 +121,14 @@ returns `true` if the buffer is empty and there are no pending senders.
 
 [`writableChannel`](../interfaces/writableChannel.md).[`isDrained`](../interfaces/writableChannel.md#isdrained)
 
-#### Defined in
-
-[channel.ts:71](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/channel.ts#L71)
-
 ***
 
 ### receive()
 
 > **receive**(): [`Op`](Op.md)\<[`Option`](../type-aliases/Option.md)\<`T`\>\>
 
+Defined in: [channel.ts:132](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/channel.ts#L132)
+
 receives a message from the channel.
 if the channel is drained, return `none`.
 
@@ -147,16 +145,14 @@ const msg = await op.sync()
 
 [`readableChannel`](../interfaces/readableChannel.md).[`receive`](../interfaces/readableChannel.md#receive)
 
-#### Defined in
-
-[channel.ts:132](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/channel.ts#L132)
-
 ***
 
 ### send()
 
 > **send**(`data`): [`Op`](Op.md)\<`boolean`\>
 
+Defined in: [channel.ts:88](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/channel.ts#L88)
+
 sends the `data` message to the channel.
 if channel is closed, return `false`.
 
@@ -167,7 +163,9 @@ await op.sync()
 
 #### Parameters
 
-• **data**: `T`
+##### data
+
+`T`
 
 #### Returns
 
@@ -176,7 +174,3 @@ await op.sync()
 #### Implementation of
 
 [`writableChannel`](../interfaces/writableChannel.md).[`send`](../interfaces/writableChannel.md#send)
-
-#### Defined in
-
-[channel.ts:88](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/channel.ts#L88)

doc/classes/Deferred.md

@@ -1,101 +1,95 @@
-[**sync-op**](../README.md) • **Docs**
+[**sync-op**](../README.md)
 
 ***
 
 [sync-op](../README.md) / Deferred
 
 # Class: Deferred\<T\>
 
+Defined in: [deferred.ts:1](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/deferred.ts#L1)
+
 ## Type Parameters
 
-• **T** = `void`
+### T
+
+`T` = `void`
 
 ## Constructors
 
-### new Deferred()
+### Constructor
 
-> **new Deferred**\<`T`\>(): [`Deferred`](Deferred.md)\<`T`\>
+> **new Deferred**\<`T`\>(): `Deferred`\<`T`\>
 
-#### Returns
+Defined in: [deferred.ts:9](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/deferred.ts#L9)
 
-[`Deferred`](Deferred.md)\<`T`\>
-
-#### Defined in
+#### Returns
 
-[deferred.ts:9](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/deferred.ts#L9)
+`Deferred`\<`T`\>
 
 ## Properties
 
 ### isFulfilled
 
 > **isFulfilled**: `boolean`
 
-#### Defined in
-
-[deferred.ts:3](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/deferred.ts#L3)
+Defined in: [deferred.ts:3](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/deferred.ts#L3)
 
 ***
 
 ### isRejected
 
 > **isRejected**: `boolean`
 
-#### Defined in
-
-[deferred.ts:5](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/deferred.ts#L5)
+Defined in: [deferred.ts:5](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/deferred.ts#L5)
 
 ***
 
 ### isResolved
 
 > **isResolved**: `boolean`
 
-#### Defined in
-
-[deferred.ts:4](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/deferred.ts#L4)
+Defined in: [deferred.ts:4](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/deferred.ts#L4)
 
 ***
 
 ### promise
 
 > **promise**: `Promise`\<`T`\>
 
-#### Defined in
-
-[deferred.ts:2](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/deferred.ts#L2)
+Defined in: [deferred.ts:2](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/deferred.ts#L2)
 
 ***
 
 ### reject()
 
-> **reject**: (`err`?) => `void`
+> **reject**: (`err?`) => `void`
+
+Defined in: [deferred.ts:7](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/deferred.ts#L7)
 
 #### Parameters
 
-• **err?**: `unknown`
+##### err?
+
+`unknown`
 
 #### Returns
 
 `void`
 
-#### Defined in
-
-[deferred.ts:7](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/deferred.ts#L7)
-
 ***
 
 ### resolve()
 
 > **resolve**: (`payload`) => `void`
 
+Defined in: [deferred.ts:6](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/deferred.ts#L6)
+
 #### Parameters
 
-• **payload**: `T` \| `PromiseLike`\<`T`\>
+##### payload
+
+`T` | `PromiseLike`\<`T`\>
 
 #### Returns
 
 `void`
-
-#### Defined in
-
-[deferred.ts:6](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/deferred.ts#L6)

doc/classes/IVar.md

@@ -1,62 +1,62 @@
-[**sync-op**](../README.md) • **Docs**
+[**sync-op**](../README.md)
 
 ***
 
 [sync-op](../README.md) / IVar
 
 # Class: IVar\<T\>
 
+Defined in: [extension.ts:210](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/extension.ts#L210)
+
 ## Type Parameters
 
-• **T**
+### T
 
-## Constructors
+`T`
 
-### new IVar()
+## Constructors
 
-> **new IVar**\<`T`\>(): [`IVar`](IVar.md)\<`T`\>
+### Constructor
 
-#### Returns
+> **new IVar**\<`T`\>(): `IVar`\<`T`\>
 
-[`IVar`](IVar.md)\<`T`\>
+Defined in: [extension.ts:213](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/extension.ts#L213)
 
-#### Defined in
+#### Returns
 
-[extension.ts:213](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/extension.ts#L213)
+`IVar`\<`T`\>
 
 ## Methods
 
 ### get()
 
 > **get**(): [`Op`](Op.md)\<`T`\>
 
+Defined in: [extension.ts:236](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/extension.ts#L236)
+
 read `IVar`
 
 #### Returns
 
 [`Op`](Op.md)\<`T`\>
 
-#### Defined in
-
-[extension.ts:236](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/extension.ts#L236)
-
 ***
 
 ### put()
 
 > **put**(`value`): `boolean`
 
+Defined in: [extension.ts:222](https://github.com/dhcmrlchtdj/sync-op/blob/93fe32636f3c6c188a811dfea276951b3e31f9bc/src/extension.ts#L222)
+
 fill `IVar` if it is empty.
 return `false` if it's not empty.
 
 #### Parameters
 
-• **value**: `T`
+##### value
+
+`T`
 
 #### Returns
 
 `boolean`
-
-#### Defined in
-
-[extension.ts:222](https://github.com/dhcmrlchtdj/sync-op/blob/163328e6c4e45f4e1851de6e0cd2086a60714f03/src/extension.ts#L222)