Skip to content
This repository has been archived by the owner on Jul 16, 2024. It is now read-only.

Commit

Permalink
upgrade to latest docgen
Browse files Browse the repository at this point in the history
  • Loading branch information
gcanti committed Aug 30, 2023
1 parent d031d7f commit e1424f2
Show file tree
Hide file tree
Showing 14 changed files with 423 additions and 55 deletions.
66 changes: 66 additions & 0 deletions docs/modules/Channel.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,11 @@ Added in v1.0.0
- [ChannelExceptionTypeId (type alias)](#channelexceptiontypeid-type-alias)
- [ChannelTypeId](#channeltypeid)
- [ChannelTypeId (type alias)](#channeltypeid-type-alias)
- [tracing](#tracing)
- [withSpan](#withspan)
- [utils](#utils)
- [Channel (namespace)](#channel-namespace)
- [Variance (interface)](#variance-interface)
- [collect](#collect)
- [concatMap](#concatmap)
- [concatMapWith](#concatmapwith)
Expand Down Expand Up @@ -1623,8 +1627,70 @@ export type ChannelTypeId = typeof ChannelTypeId
Added in v1.0.0
# tracing
## withSpan
Wraps the channel with a new span for tracing.
**Signature**
```ts
export declare const withSpan: {
(
name: string,
options?: {
readonly attributes?: Record<string, Tracer.AttributeValue>
readonly links?: ReadonlyArray<Tracer.SpanLink>
readonly parent?: Tracer.ParentSpan
readonly root?: boolean
readonly context?: Context.Context<never>
}
): <Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
) => Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>,
name: string,
options?: {
readonly attributes?: Record<string, Tracer.AttributeValue>
readonly links?: ReadonlyArray<Tracer.SpanLink>
readonly parent?: Tracer.ParentSpan
readonly root?: boolean
readonly context?: Context.Context<never>
}
): Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
}
```
Added in v1.0.0
# utils
## Channel (namespace)
Added in v1.0.0
### Variance (interface)
**Signature**
```ts
export interface Variance<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone> {
readonly [ChannelTypeId]: {
_Env: (_: never) => Env
_InErr: (_: InErr) => void
_InElem: (_: InElem) => void
_InDone: (_: InDone) => void
_OutErr: (_: never) => OutErr
_OutElem: (_: never) => OutElem
_OutDone: (_: never) => OutDone
}
}
```

Added in v1.0.0

## collect

Returns a new channel, which is the same as this one, except its outputs
Expand Down
21 changes: 21 additions & 0 deletions docs/modules/Channel/ChildExecutorDecision.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ Added in v1.0.0
- [symbols](#symbols)
- [ChildExecutorDecisionTypeId](#childexecutordecisiontypeid)
- [ChildExecutorDecisionTypeId (type alias)](#childexecutordecisiontypeid-type-alias)
- [utils](#utils)
- [ChildExecutorDecision (namespace)](#childexecutordecision-namespace)
- [Proto (interface)](#proto-interface)

---

Expand Down Expand Up @@ -220,3 +223,21 @@ export type ChildExecutorDecisionTypeId = typeof ChildExecutorDecisionTypeId
```
Added in v1.0.0
# utils
## ChildExecutorDecision (namespace)
Added in v1.0.0
### Proto (interface)
**Signature**
```ts
export interface Proto {
readonly [ChildExecutorDecisionTypeId]: ChildExecutorDecisionTypeId
}
```

Added in v1.0.0
27 changes: 27 additions & 0 deletions docs/modules/Channel/MergeDecision.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ Added in v1.0.0
- [symbols](#symbols)
- [MergeDecisionTypeId](#mergedecisiontypeid)
- [MergeDecisionTypeId (type alias)](#mergedecisiontypeid-type-alias)
- [utils](#utils)
- [MergeDecision (namespace)](#mergedecision-namespace)
- [Variance (interface)](#variance-interface)

---

Expand Down Expand Up @@ -134,3 +137,27 @@ export type MergeDecisionTypeId = typeof MergeDecisionTypeId
```
Added in v1.0.0
# utils
## MergeDecision (namespace)
Added in v1.0.0
### Variance (interface)
**Signature**
```ts
export interface Variance<R, E0, Z0, E, Z> {
readonly [MergeDecisionTypeId]: {
_R: (_: never) => R
_E0: (_: E0) => void
_Z0: (_: Z0) => void
_E: (_: never) => E
_Z: (_: never) => Z
}
}
```

Added in v1.0.0
21 changes: 21 additions & 0 deletions docs/modules/Channel/MergeState.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ Added in v1.0.0
- [symbols](#symbols)
- [MergeStateTypeId](#mergestatetypeid)
- [MergeStateTypeId (type alias)](#mergestatetypeid-type-alias)
- [utils](#utils)
- [MergeState (namespace)](#mergestate-namespace)
- [Proto (interface)](#proto-interface)

---

Expand Down Expand Up @@ -242,3 +245,21 @@ export type MergeStateTypeId = typeof MergeStateTypeId
```
Added in v1.0.0
# utils
## MergeState (namespace)
Added in v1.0.0
### Proto (interface)
**Signature**
```ts
export interface Proto {
readonly [MergeStateTypeId]: MergeStateTypeId
}
```

Added in v1.0.0
21 changes: 21 additions & 0 deletions docs/modules/Channel/MergeStrategy.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ Added in v1.0.0
- [symbols](#symbols)
- [MergeStrategyTypeId](#mergestrategytypeid)
- [MergeStrategyTypeId (type alias)](#mergestrategytypeid-type-alias)
- [utils](#utils)
- [MergeStrategy (namespace)](#mergestrategy-namespace)
- [Proto (interface)](#proto-interface)

---

Expand Down Expand Up @@ -168,3 +171,21 @@ export type MergeStrategyTypeId = typeof MergeStrategyTypeId
```
Added in v1.0.0
# utils
## MergeStrategy (namespace)
Added in v1.0.0
### Proto (interface)
**Signature**
```ts
export interface Proto {
readonly [MergeStrategyTypeId]: MergeStrategyTypeId
}
```

Added in v1.0.0
23 changes: 23 additions & 0 deletions docs/modules/Channel/UpstreamPullRequest.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ Added in v1.0.0
- [symbols](#symbols)
- [UpstreamPullRequestTypeId](#upstreampullrequesttypeid)
- [UpstreamPullRequestTypeId (type alias)](#upstreampullrequesttypeid-type-alias)
- [utils](#utils)
- [UpstreamPullRequest (namespace)](#upstreampullrequest-namespace)
- [Variance (interface)](#variance-interface)

---

Expand Down Expand Up @@ -176,3 +179,23 @@ export type UpstreamPullRequestTypeId = typeof UpstreamPullRequestTypeId
```
Added in v1.0.0
# utils
## UpstreamPullRequest (namespace)
Added in v1.0.0
### Variance (interface)
**Signature**
```ts
export interface Variance<A> {
readonly [UpstreamPullRequestTypeId]: {
readonly _A: (_: never) => A
}
}
```

Added in v1.0.0
23 changes: 23 additions & 0 deletions docs/modules/Channel/UpstreamPullStrategy.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ Added in v1.0.0
- [symbols](#symbols)
- [UpstreamPullStrategyTypeId](#upstreampullstrategytypeid)
- [UpstreamPullStrategyTypeId (type alias)](#upstreampullstrategytypeid-type-alias)
- [utils](#utils)
- [UpstreamPullStrategy (namespace)](#upstreampullstrategy-namespace)
- [Variance (interface)](#variance-interface)

---

Expand Down Expand Up @@ -179,3 +182,23 @@ export type UpstreamPullStrategyTypeId = typeof UpstreamPullStrategyTypeId
```
Added in v1.0.0
# utils
## UpstreamPullStrategy (namespace)
Added in v1.0.0
### Variance (interface)
**Signature**
```ts
export interface Variance<A> {
readonly [UpstreamPullStrategyTypeId]: {
readonly _A: (_: never) => A
}
}
```

Added in v1.0.0
23 changes: 23 additions & 0 deletions docs/modules/GroupBy.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Added in v1.0.0
- [GroupByTypeId](#groupbytypeid)
- [GroupByTypeId (type alias)](#groupbytypeid-type-alias)
- [utils](#utils)
- [GroupBy (namespace)](#groupby-namespace)
- [Variance (interface)](#variance-interface)
- [filter](#filter)
- [first](#first)

Expand Down Expand Up @@ -131,6 +133,27 @@ Added in v1.0.0
# utils
## GroupBy (namespace)
Added in v1.0.0
### Variance (interface)
**Signature**
```ts
export interface Variance<R, E, K, V> {
readonly [GroupByTypeId]: {
readonly _R: (_: never) => R
readonly _E: (_: never) => E
readonly _K: (_: never) => K
readonly _V: (_: never) => V
}
}
```

Added in v1.0.0

## filter

Filter the groups to be processed.
Expand Down
24 changes: 24 additions & 0 deletions docs/modules/Sink.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@ Added in v1.0.0
- [SinkTypeId](#sinktypeid)
- [SinkTypeId (type alias)](#sinktypeid-type-alias)
- [utils](#utils)
- [Sink (namespace)](#sink-namespace)
- [Variance (interface)](#variance-interface)
- [collectAllFrom](#collectallfrom)
- [collectAllWhileWith](#collectallwhilewith)
- [collectLeftover](#collectleftover)
Expand Down Expand Up @@ -1667,6 +1669,28 @@ Added in v1.0.0
# utils
## Sink (namespace)
Added in v1.0.0
### Variance (interface)
**Signature**
```ts
export interface Variance<R, E, In, L, Z> {
readonly [SinkTypeId]: {
_R: (_: never) => R
_E: (_: never) => E
_In: (_: In) => void
_L: (_: never) => L
_Z: (_: never) => Z
}
}
```

Added in v1.0.0

## collectAllFrom

Repeatedly runs the sink and accumulates its results into a `Chunk`.
Expand Down
Loading

0 comments on commit e1424f2

Please sign in to comment.