@rnw-community/rxjs-errors 0.52.0 → 0.53.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rnw-community/rxjs-errors",
-  "version": "0.52.0",
+  "version": "0.53.0",
   "description": "RxJS errors utils",
   "keywords": [
     "rxjs error operator",
@@ -38,13 +38,13 @@
     "clear": "rm -rf coverage && rm -rf dist && rm -f *.tsbuildinfo",
     "clear:deps": "rm -rf ./node_modules && rm -rf ./dist"
   },
-  "gitHead": "211eeb8364d01f82b650c738b64fc650b63898d6",
+  "gitHead": "4ea55d84a33098abf2830f86bb94ba44f7ee0c20",
   "peerDependencies": {
     "@rnw-community/shared": "^0.49.0",
     "rxjs": "^7.4.0"
   },
   "devDependencies": {
-    "@rnw-community/shared": "^0.52.0",
+    "@rnw-community/shared": "^0.53.0",
     "expect-type": "^0.13.0",
     "rxjs": "^7.4.0"
   }

package/readme.md

@@ -1,20 +1,23 @@
 # RxJS error utils
 
-Utils that help work with errors in rxjs observable's
+Utils that help work with errors in rxjs observable's.
+
+[![npm version](https://badge.fury.io/js/%40rnw-community%2Frxjs-errors.svg)](https://badge.fury.io/js/%40rnw-community%2Frxjs-errors)
+[![npm downloads](https://img.shields.io/npm/dm/%40rnw-community%2Frxjs-errors.svg)](https://www.npmjs.com/package/%40rnw-community%2Frxjs-errors)
 
 ## Classes
 
-- `RxJSFilterError` - custom error used by error operators.
+-   `RxJSFilterError` - custom error used by error operators.
 
 ## Available operators
 
-- [`filterWithException`](#filterwithexception) - works like `filter` from rxjs, but throw an error instead of ignoring the
-  value.
+-   [`filterWithException`](#filterwithexception) - works like `filter` from rxjs, but throw an error instead of ignoring the
+    value.
 
-- [`rethrowException`](#rethrowexception) - will catch any error in the observable, create a
-  new `RxJSFilterError` (or any custom) with custom message and log it with a custom logger function that you can optionally
-  pass in. If it catches `RxJSFilterError` (or any custom), it will
-  just rethrow that exception as is.
+-   [`rethrowException`](#rethrowexception) - will catch any error in the observable, create a
+    new `RxJSFilterError` (or any custom) with custom message and log it with a custom logger function that you can optionally
+    pass in. If it catches `RxJSFilterError` (or any custom), it will
+    just rethrow that exception as is.
 
 ## Usage examples
 
@@ -27,7 +30,12 @@ import { of } from 'rxjs';
 import { filterWithException } from '@rnw-community/rxjs-errors';
 
 of('C')
-    .pipe(filterWithException(letter => letter === 'A', letter => `Wanted A, but got ${letter}`))
+    .pipe(
+        filterWithException(
+            letter => letter === 'A',
+            letter => `Wanted A, but got ${letter}`
+        )
+    )
     .subscribe(value => console.log(value));
 ```
 
@@ -39,7 +47,13 @@ import { BadRequestException } from '@nestjs/common';
 import { of } from 'rxjs';
 
 of('F')
-    .pipe(filterWithException(letter => letter === 'A', letter => `Wanted A, but got ${letter}`, BadRequestException))
+    .pipe(
+        filterWithException(
+            letter => letter === 'A',
+            letter => `Wanted A, but got ${letter}`,
+            BadRequestException
+        )
+    )
     .subscribe(value => console.log(value));
 ```
 
@@ -55,7 +69,7 @@ const isString = (val: unknown): val is string => typeof val === 'string';
 
 of(value) // `unknown` here
     .pipe(filterWithException(isString, value => `Wanted string, but got ${typeof value}`))
-    .subscribe(value /* `string` here */ => {
+    .subscribe((value) /* `string` here */ => {
         console.log(value);
     });
 ```
@@ -84,39 +98,36 @@ import { filterWithException, rethrowException } from '@rnw-community/rxjs-error
 import { of } from 'rxjs';
 
 class LetterService {
-    constructor(private readonly repository: ILetterRepository) {
-    }
+    constructor(private readonly repository: ILetterRepository) {}
 
     checkLetter$(letter: string): Observable<string> {
         return of(letter).pipe(
-            filterWithException(letter !== 'A', "Invalid character"),
+            filterWithException(letter !== 'A', 'Invalid character'),
             concatMap(letter => this.repository.doSomething(letter)),
             rethrowException('Could not check letter', console.error)
-        )
+        );
     }
 }
 ```
 
-In this example any error except for `LetterError` will be caught, logged and a `LetterError` will be thrown with a  "Could
+In this example any error except for `LetterError` will be caught, logged and a `LetterError` will be thrown with a "Could
 not check letter" message.
 
 ```typescript
 import { filterWithException, rethrowException } from '@rnw-community/rxjs-errors/src';
 import { of } from 'rxjs';
 
-class LetterError extends Error {
-}
+class LetterError extends Error {}
 
 class LetterService {
-    constructor(private readonly repository: ILetterRepository) {
-    }
+    constructor(private readonly repository: ILetterRepository) {}
 
     checkLetter$(letter: string): Observable<string> {
         return of(letter).pipe(
-            filterWithException(letter !== 'A', "Invalid character"),
+            filterWithException(letter !== 'A', 'Invalid character'),
             concatMap(letter => this.repository.doSomething(letter)),
             rethrowException('Could not check letter', console.error, LetterError)
-        )
+        );
     }
 }
 ```
@@ -129,15 +140,14 @@ import { getErrorMessage } from '@rnw-community/shared';
 import { of } from 'rxjs';
 
 class LetterService {
-    constructor(private readonly repository: ILetterRepository) {
-    }
+    constructor(private readonly repository: ILetterRepository) {}
 
     checkLetter$(letter: string): Observable<string> {
         return of(letter).pipe(
-            filterWithException(letter !== 'A', "Invalid character"),
+            filterWithException(letter !== 'A', 'Invalid character'),
             concatMap(letter => this.repository.doSomething(letter)),
             rethrowException((err: unknown) => getErrorMessage(err), console.error)
-        )
+        );
     }
 }
 ```
@@ -150,15 +160,14 @@ import { getErrorMessage } from '@rnw-community/shared';
 import { of } from 'rxjs';
 
 class LetterService {
-    constructor(private readonly repository: ILetterRepository) {
-    }
+    constructor(private readonly repository: ILetterRepository) {}
 
     checkLetter$(letter: string): Observable<string> {
         return of(letter).pipe(
-            filterWithException(letter !== 'A', "Invalid character"),
+            filterWithException(letter !== 'A', 'Invalid character'),
             concatMap(letter => this.repository.doSomething(letter)),
             rethrowException('Could not check letter')
-        )
+        );
     }
 }
 ```