Skip to content

Commit

Permalink
remove instance operations category
Browse files Browse the repository at this point in the history
  • Loading branch information
gcanti committed Sep 30, 2022
1 parent bb35944 commit df9c5fc
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 46 deletions.
55 changes: 26 additions & 29 deletions docs/modules/Either.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,6 @@ Added in v2.0.0
- [foldMap](#foldmap)
- [reduce](#reduce)
- [reduceRight](#reduceright)
- [instance operations](#instance-operations)
- [apW](#apw)
- [throwError](#throwerror)
- [instances](#instances)
- [Alt](#alt)
- [Applicative](#applicative)
Expand Down Expand Up @@ -183,12 +180,14 @@ Added in v2.0.0
- [apFirstW](#apfirstw)
- [apSecond](#apsecond)
- [apSecondW](#apsecondw)
- [apW](#apw)
- [duplicate](#duplicate)
- [elem](#elem)
- [exists](#exists)
- [extend](#extend)
- [sequenceArray](#sequencearray)
- [swap](#swap)
- [throwError](#throwerror)
- [toError](#toerror)
- [traverseArray](#traversearray)
- [traverseArrayWithIndex](#traversearraywithindex)
Expand Down Expand Up @@ -855,32 +854,6 @@ assert.deepStrictEqual(pipe(E.left('e'), E.reduceRight(startWith, concat)), 'pos
Added in v2.0.0
# instance operations
## apW
Less strict version of [`ap`](#ap).
The `W` suffix (short for **W**idening) means that the error types will be merged.
**Signature**
```ts
export declare const apW: <E2, A>(fa: Either<E2, A>) => <E1, B>(fab: Either<E1, (a: A) => B>) => Either<E2 | E1, B>
```
Added in v2.8.0
## throwError
**Signature**
```ts
export declare const throwError: <E, A>(e: E) => Either<E, A>
```
Added in v2.6.3
# instances
## Alt
Expand Down Expand Up @@ -1752,6 +1725,20 @@ export declare const apSecondW: <E2, B>(second: Either<E2, B>) => <E1, A>(first:
Added in v2.12.0
## apW
Less strict version of [`ap`](#ap).
The `W` suffix (short for **W**idening) means that the error types will be merged.
**Signature**
```ts
export declare const apW: <E2, A>(fa: Either<E2, A>) => <E1, B>(fab: Either<E1, (a: A) => B>) => Either<E2 | E1, B>
```
Added in v2.8.0
## duplicate
**Signature**
Expand Down Expand Up @@ -1831,6 +1818,16 @@ export declare const swap: <E, A>(ma: Either<E, A>) => Either<A, E>
Added in v2.0.0
## throwError
**Signature**
```ts
export declare const throwError: <E, A>(e: E) => Either<E, A>
```
Added in v2.6.3
## toError
Default value for the `onError` argument of `tryCatch`
Expand Down
25 changes: 11 additions & 14 deletions docs/modules/Option.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,6 @@ Added in v2.0.0
- [foldMap](#foldmap)
- [reduce](#reduce)
- [reduceRight](#reduceright)
- [instance operations](#instance-operations)
- [throwError](#throwerror)
- [instances](#instances)
- [Alt](#alt)
- [Alternative](#alternative)
Expand Down Expand Up @@ -181,6 +179,7 @@ Added in v2.0.0
- [exists](#exists)
- [extend](#extend)
- [sequenceArray](#sequencearray)
- [throwError](#throwerror)
- [traverseArray](#traversearray)
- [traverseArrayWithIndex](#traversearraywithindex)
- [traverseReadonlyArrayWithIndex](#traversereadonlyarraywithindex)
Expand Down Expand Up @@ -671,18 +670,6 @@ export declare const reduceRight: <A, B>(b: B, f: (a: A, b: B) => B) => (fa: Opt
Added in v2.0.0
# instance operations
## throwError
**Signature**
```ts
export declare const throwError: <E, A>(e: E) => Option<A>
```
Added in v2.7.0
# instances
## Alt
Expand Down Expand Up @@ -1679,6 +1666,16 @@ export declare const sequenceArray: <A>(arr: readonly Option<A>[]) => Option<rea

Added in v2.9.0

## throwError

**Signature**

```ts
export declare const throwError: <E, A>(e: E) => Option<A>
```

Added in v2.7.0

## traverseArray

**Signature**
Expand Down
2 changes: 0 additions & 2 deletions src/Either.ts
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,6 @@ export const Pointed: Pointed2<URI> = {
*
* The `W` suffix (short for **W**idening) means that the error types will be merged.
*
* @category instance operations
* @since 2.8.0
*/
export const apW: <E2, A>(fa: Either<E2, A>) => <E1, B>(fab: Either<E1, (a: A) => B>) => Either<E1 | E2, B> =
Expand Down Expand Up @@ -875,7 +874,6 @@ export const ChainRec: ChainRec2<URI> = {
}

/**
* @category instance operations
* @since 2.6.3
*/
export const throwError: MonadThrow2<URI>['throwError'] = left
Expand Down
1 change: 0 additions & 1 deletion src/Option.ts
Original file line number Diff line number Diff line change
Expand Up @@ -736,7 +736,6 @@ export const Witherable: Witherable1<URI> = {
}

/**
* @category instance operations
* @since 2.7.0
*/
export const throwError: MonadThrow1<URI>['throwError'] = () => none
Expand Down

0 comments on commit df9c5fc

Please sign in to comment.