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

Commit

Permalink
rename contramap* functions to mapInput* functions, closes #180
Browse files Browse the repository at this point in the history 
- Channel
  - contramap
  - contramapEffect
  - contramapError
  - contramapErrorEffect
  - contramapIn
  - contramapInEffect
  - contramapContext
- Sink
  - contramap
  - contramapEffect
  - contramapChunks
  - contramapChunksEffect
- Stream
  - contramapContext
  • Loading branch information
@gcanti
gcanti committed Sep 22, 2023
1 parent eab4bdb commit 21b3249
Show file tree
Hide file tree
Showing 12 changed files with 323 additions and 302 deletions.
21 changes: 21 additions & 0 deletions .changeset/nasty-experts-provide.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
"@effect/stream": minor
---

rename contramap* functions to mapInput* functions:

- Channel
- contramap
- contramapEffect
- contramapError
- contramapErrorEffect
- contramapIn
- contramapInEffect
- contramapContext
- Sink
- contramap
- contramapEffect
- contramapChunks
- contramapChunksEffect
- Stream
- contramapContext
306 changes: 153 additions & 153 deletions docs/modules/Channel.ts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Added in v1.0.0
- [contextWith](#contextwith)
- [contextWithChannel](#contextwithchannel)
- [contextWithEffect](#contextwitheffect)
- [contramapContext](#contramapcontext)
- [mapInputContext](#mapinputcontext)
- [provideContext](#providecontext)
- [provideLayer](#providelayer)
- [provideService](#provideservice)
Expand Down Expand Up @@ -109,12 +109,6 @@ Added in v1.0.0
- [concatMapWith](#concatmapwith)
- [concatMapWithCustom](#concatmapwithcustom)
- [concatOut](#concatout)
- [contramap](#contramap)
- [contramapEffect](#contramapeffect)
- [contramapError](#contramaperror)
- [contramapErrorEffect](#contramaperroreffect)
- [contramapIn](#contramapin)
- [contramapInEffect](#contramapineffect)
- [doneCollect](#donecollect)
- [drain](#drain)
- [embedInput](#embedinput)
Expand All @@ -125,6 +119,12 @@ Added in v1.0.0
- [foldChannel](#foldchannel)
- [interruptWhen](#interruptwhen)
- [interruptWhenDeferred](#interruptwhendeferred)
- [mapInput](#mapinput)
- [mapInputEffect](#mapinputeffect)
- [mapInputError](#mapinputerror)
- [mapInputErrorEffect](#mapinputerroreffect)
- [mapInputIn](#mapinputin)
- [mapInputInEffect](#mapinputineffect)
- [mergeAll](#mergeall)
- [mergeAllUnbounded](#mergeallunbounded)
- [mergeAllUnboundedWith](#mergeallunboundedwith)
Expand Down Expand Up @@ -696,15 +696,15 @@ export declare const contextWithEffect: <Env, Env1, OutErr, OutDone>(
Added in v1.0.0
## contramapContext
## mapInputContext
Transforms the context being provided to the channel with the specified
function.
**Signature**
```ts
export declare const contramapContext: {
export declare const mapInputContext: {
<Env0, Env>(f: (env: Context.Context<Env0>) => Context.Context<Env>): <
InErr,
InElem,
Expand Down Expand Up @@ -1863,150 +1863,6 @@ export declare const concatOut: <Env, InErr, InElem, InDone, OutErr, OutElem, Ou
Added in v1.0.0
## contramap
Returns a new channel which is the same as this one but applies the given
function to the input channel's done value.
**Signature**
```ts
export declare const contramap: {
<InDone0, InDone>(f: (a: InDone0) => InDone): <Env, InErr, InElem, OutErr, OutElem, OutDone>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
) => Channel<Env, InErr, InElem, InDone0, OutErr, OutElem, OutDone>
<Env, InErr, InElem, OutErr, OutElem, OutDone, InDone0, InDone>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>,
f: (a: InDone0) => InDone
): Channel<Env, InErr, InElem, InDone0, OutErr, OutElem, OutDone>
}
```
Added in v1.0.0
## contramapEffect
Returns a new channel which is the same as this one but applies the given
effectual function to the input channel's done value.
**Signature**
```ts
export declare const contramapEffect: {
<Env1, InErr, InDone0, InDone>(f: (i: InDone0) => Effect.Effect<Env1, InErr, InDone>): <
Env,
InElem,
OutErr,
OutElem,
OutDone
>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
) => Channel<Env1 | Env, InErr, InElem, InDone0, OutErr, OutElem, OutDone>
<Env, InElem, OutErr, OutElem, OutDone, Env1, InErr, InDone0, InDone>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>,
f: (i: InDone0) => Effect.Effect<Env1, InErr, InDone>
): Channel<Env | Env1, InErr, InElem, InDone0, OutErr, OutElem, OutDone>
}
```
Added in v1.0.0
## contramapError
Returns a new channel which is the same as this one but applies the given
function to the input channel's error value.
**Signature**
```ts
export declare const contramapError: {
<InErr0, InErr>(f: (a: InErr0) => InErr): <Env, InElem, InDone, OutErr, OutElem, OutDone>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
) => Channel<Env, InErr0, InElem, InDone, OutErr, OutElem, OutDone>
<Env, InElem, InDone, OutErr, OutElem, OutDone, InErr0, InErr>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>,
f: (a: InErr0) => InErr
): Channel<Env, InErr0, InElem, InDone, OutErr, OutElem, OutDone>
}
```
Added in v1.0.0
## contramapErrorEffect
Returns a new channel which is the same as this one but applies the given
effectual function to the input channel's error value.
**Signature**
```ts
export declare const contramapErrorEffect: {
<Env1, InErr0, InErr, InDone>(f: (error: InErr0) => Effect.Effect<Env1, InErr, InDone>): <
Env,
InElem,
OutErr,
OutElem,
OutDone
>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
) => Channel<Env1 | Env, InErr0, InElem, InDone, OutErr, OutElem, OutDone>
<Env, InElem, OutErr, OutElem, OutDone, Env1, InErr0, InErr, InDone>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>,
f: (error: InErr0) => Effect.Effect<Env1, InErr, InDone>
): Channel<Env | Env1, InErr0, InElem, InDone, OutErr, OutElem, OutDone>
}
```
Added in v1.0.0
## contramapIn
Returns a new channel which is the same as this one but applies the given
function to the input channel's output elements.
**Signature**
```ts
export declare const contramapIn: {
<InElem0, InElem>(f: (a: InElem0) => InElem): <Env, InErr, InDone, OutErr, OutElem, OutDone>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
) => Channel<Env, InErr, InElem0, InDone, OutErr, OutElem, OutDone>
<Env, InErr, InDone, OutErr, OutElem, OutDone, InElem0, InElem>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>,
f: (a: InElem0) => InElem
): Channel<Env, InErr, InElem0, InDone, OutErr, OutElem, OutDone>
}
```
Added in v1.0.0
## contramapInEffect
Returns a new channel which is the same as this one but applies the given
effectual function to the input channel's output elements.
**Signature**
```ts
export declare const contramapInEffect: {
<Env1, InErr, InElem0, InElem>(f: (a: InElem0) => Effect.Effect<Env1, InErr, InElem>): <
Env,
InDone,
OutErr,
OutElem,
OutDone
>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
) => Channel<Env1 | Env, InErr, InElem0, InDone, OutErr, OutElem, OutDone>
<Env, InDone, OutErr, OutElem, OutDone, Env1, InErr, InElem0, InElem>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>,
f: (a: InElem0) => Effect.Effect<Env1, InErr, InElem>
): Channel<Env | Env1, InErr, InElem0, InDone, OutErr, OutElem, OutDone>
}
```
Added in v1.0.0
## doneCollect
Returns a new channel, which is the same as this one, except that all the
Expand Down Expand Up @@ -2364,6 +2220,150 @@ export declare const interruptWhenDeferred: {
Added in v1.0.0
## mapInput
Returns a new channel which is the same as this one but applies the given
function to the input channel's done value.
**Signature**
```ts
export declare const mapInput: {
<InDone0, InDone>(f: (a: InDone0) => InDone): <Env, InErr, InElem, OutErr, OutElem, OutDone>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
) => Channel<Env, InErr, InElem, InDone0, OutErr, OutElem, OutDone>
<Env, InErr, InElem, OutErr, OutElem, OutDone, InDone0, InDone>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>,
f: (a: InDone0) => InDone
): Channel<Env, InErr, InElem, InDone0, OutErr, OutElem, OutDone>
}
```
Added in v1.0.0
## mapInputEffect
Returns a new channel which is the same as this one but applies the given
effectual function to the input channel's done value.
**Signature**
```ts
export declare const mapInputEffect: {
<Env1, InErr, InDone0, InDone>(f: (i: InDone0) => Effect.Effect<Env1, InErr, InDone>): <
Env,
InElem,
OutErr,
OutElem,
OutDone
>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
) => Channel<Env1 | Env, InErr, InElem, InDone0, OutErr, OutElem, OutDone>
<Env, InElem, OutErr, OutElem, OutDone, Env1, InErr, InDone0, InDone>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>,
f: (i: InDone0) => Effect.Effect<Env1, InErr, InDone>
): Channel<Env | Env1, InErr, InElem, InDone0, OutErr, OutElem, OutDone>
}
```
Added in v1.0.0
## mapInputError
Returns a new channel which is the same as this one but applies the given
function to the input channel's error value.
**Signature**
```ts
export declare const mapInputError: {
<InErr0, InErr>(f: (a: InErr0) => InErr): <Env, InElem, InDone, OutErr, OutElem, OutDone>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
) => Channel<Env, InErr0, InElem, InDone, OutErr, OutElem, OutDone>
<Env, InElem, InDone, OutErr, OutElem, OutDone, InErr0, InErr>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>,
f: (a: InErr0) => InErr
): Channel<Env, InErr0, InElem, InDone, OutErr, OutElem, OutDone>
}
```
Added in v1.0.0
## mapInputErrorEffect
Returns a new channel which is the same as this one but applies the given
effectual function to the input channel's error value.
**Signature**
```ts
export declare const mapInputErrorEffect: {
<Env1, InErr0, InErr, InDone>(f: (error: InErr0) => Effect.Effect<Env1, InErr, InDone>): <
Env,
InElem,
OutErr,
OutElem,
OutDone
>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
) => Channel<Env1 | Env, InErr0, InElem, InDone, OutErr, OutElem, OutDone>
<Env, InElem, OutErr, OutElem, OutDone, Env1, InErr0, InErr, InDone>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>,
f: (error: InErr0) => Effect.Effect<Env1, InErr, InDone>
): Channel<Env | Env1, InErr0, InElem, InDone, OutErr, OutElem, OutDone>
}
```
Added in v1.0.0
## mapInputIn
Returns a new channel which is the same as this one but applies the given
function to the input channel's output elements.
**Signature**
```ts
export declare const mapInputIn: {
<InElem0, InElem>(f: (a: InElem0) => InElem): <Env, InErr, InDone, OutErr, OutElem, OutDone>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
) => Channel<Env, InErr, InElem0, InDone, OutErr, OutElem, OutDone>
<Env, InErr, InDone, OutErr, OutElem, OutDone, InElem0, InElem>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>,
f: (a: InElem0) => InElem
): Channel<Env, InErr, InElem0, InDone, OutErr, OutElem, OutDone>
}
```
Added in v1.0.0
## mapInputInEffect
Returns a new channel which is the same as this one but applies the given
effectual function to the input channel's output elements.
**Signature**
```ts
export declare const mapInputInEffect: {
<Env1, InErr, InElem0, InElem>(f: (a: InElem0) => Effect.Effect<Env1, InErr, InElem>): <
Env,
InDone,
OutErr,
OutElem,
OutDone
>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
) => Channel<Env1 | Env, InErr, InElem0, InDone, OutErr, OutElem, OutDone>
<Env, InDone, OutErr, OutElem, OutDone, Env1, InErr, InElem0, InElem>(
self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>,
f: (a: InElem0) => Effect.Effect<Env1, InErr, InElem>
): Channel<Env | Env1, InErr, InElem0, InDone, OutErr, OutElem, OutDone>
}
```
Added in v1.0.0
## mergeAll
**Signature**
Expand Down
Loading

0 comments on commit 21b3249

Please sign in to comment.