Merge pull request #2 from DudeBro249/docs

Cleaned up documentation - finished most concepts
providerx · Mar 31, 2021 · 99ccc7d · 99ccc7d
2 parents 4e32e14 + c30e141
commit 99ccc7d
Show file tree

Hide file tree

Showing 25 changed files with 38,973 additions and 21,318 deletions.
diff --git a/react-providerx/package-lock.json b/react-providerx/package-lock.json
diff --git a/react-providerx/package.json b/react-providerx/package.json
@@ -16,11 +16,9 @@
   ],
   "author": "DudeBro249",
   "license": "Apache-2.0",
-  "dependencies": {
-    "rxjs": "^6.6.6"
-  },
   "devDependencies": {
     "@types/node": "^14.14.37",
-    "@types/react": "^17.0.3"
+    "@types/react": "^17.0.3",
+    "rxjs": "^6.6.7"
   }
 }
diff --git a/react-providerx/src/hooks/useProvider.ts b/react-providerx/src/hooks/useProvider.ts
@@ -31,7 +31,7 @@ export const useProvider = <T>(provider: BaseObservableProvider<T>) => {
     }, [provider])
 
     return {
-        isLoading: (currentValue === null || currentValue === undefined) && (currentError === null || currentError === undefined),
+        isLoading: currentValue === undefined && currentError === undefined,
         data: currentValue,
         error: currentError,
     } as UseProviderValues<T>

diff --git a/react-providerx/src/observableProvider/autoDispose.ts b/react-providerx/src/observableProvider/autoDispose.ts
@@ -3,8 +3,8 @@ import { ProviderReference } from "../models/providerReference";
 import { BaseObservableProvider } from "./base";
 
 export class AutoDisposeObservableProvider<T> extends BaseObservableProvider<T> {
-    _valueSubject$: BehaviorSubject<T> | BehaviorSubject<null>
-    _errorSubject$: BehaviorSubject<T> | BehaviorSubject<null>
+    _valueSubject$: BehaviorSubject<T> | BehaviorSubject<undefined>
+    _errorSubject$: BehaviorSubject<T> | BehaviorSubject<undefined>
     observableCreator
     ref: ProviderReference
     _observable$: Observable<T>
@@ -17,8 +17,8 @@ export class AutoDisposeObservableProvider<T> extends BaseObservableProvider<T>
             maintainState: true
         }
         this._observable$ = new Observable()
-        this._valueSubject$ = new BehaviorSubject(null)
-        this._errorSubject$ = new BehaviorSubject(null)
+        this._valueSubject$ = new BehaviorSubject(undefined)
+        this._errorSubject$ = new BehaviorSubject(undefined)
     }
 
     static fromPromise<S>(promise: () => Promise<S>): AutoDisposeObservableProvider<S> {
@@ -50,8 +50,8 @@ export class AutoDisposeObservableProvider<T> extends BaseObservableProvider<T>
         if(this._internalSubscription !== undefined) {
             this._internalSubscription.unsubscribe()
         }
-        this._valueSubject$ = new BehaviorSubject(null)
-        this._errorSubject$ = new BehaviorSubject(null)
+        this._valueSubject$ = new BehaviorSubject(undefined)
+        this._errorSubject$ = new BehaviorSubject(undefined)
     }
 
     registerUnsubscribe() {

diff --git a/react-providerx/src/observableProvider/base.ts b/react-providerx/src/observableProvider/base.ts
@@ -1,19 +1,23 @@
 import { BehaviorSubject, Observable, Subscription } from 'rxjs'
 
 export abstract class BaseObservableProvider<T> {
-    _valueSubject$: BehaviorSubject<T> | BehaviorSubject<null>
-    _errorSubject$: BehaviorSubject<T> | BehaviorSubject<null>
+    _valueSubject$: BehaviorSubject<T> | BehaviorSubject<undefined>
+    _errorSubject$: BehaviorSubject<T> | BehaviorSubject<undefined>
     observableCreator
     _observable$: Observable<T>
+    _internalSubscription?: Subscription
 
     constructor(observableCreator: any) {
         this.observableCreator = observableCreator
         this._observable$ = new Observable()
-        this._valueSubject$ = new BehaviorSubject(null)
-        this._errorSubject$ = new BehaviorSubject(null)
+        this._valueSubject$ = new BehaviorSubject(undefined)
+        this._errorSubject$ = new BehaviorSubject(undefined)
     }
 
-    public get valueObservable() {
+    public get observable() {
+        if(this._internalSubscription === undefined) {
+            this._compute()
+        }
         return this._valueSubject$.asObservable() as Observable<T>
     }
 
@@ -23,7 +27,7 @@ export abstract class BaseObservableProvider<T> {
 
     subscribe(dataCallback: (value: T) => void, errorCallback: (error: any) => void): Subscription[] {
         this._compute()
-        return [this.valueObservable.subscribe(dataCallback), this.errorObservable.subscribe(errorCallback)]
+        return [this.observable.subscribe(dataCallback), this.errorObservable.subscribe(errorCallback)]
     }
 
     abstract _compute(): void

diff --git a/react-providerx/src/observableProvider/index.ts b/react-providerx/src/observableProvider/index.ts
@@ -1,37 +1,34 @@
-import { BehaviorSubject, from, Observable } from 'rxjs'
+import { BehaviorSubject, Observable, Subscription } from 'rxjs'
 import { ProviderReference } from '../models/providerReference'
 import { AutoDisposeObservableProvider } from './autoDispose'
 import { BaseObservableProvider } from './base'
 
 
 export class ObservableProvider<T> extends BaseObservableProvider<T> {
-    _valueSubject$: BehaviorSubject<T> | BehaviorSubject<null>
-    _errorSubject$: BehaviorSubject<T> | BehaviorSubject<null>
+    _valueSubject$: BehaviorSubject<T> | BehaviorSubject<undefined>
+    _errorSubject$: BehaviorSubject<T> | BehaviorSubject<undefined>
     observableCreator
     _observable$: Observable<T>
+    _internalSubscription?: Subscription
 
     constructor(observableCreator: () => Observable<T>) {
         super(observableCreator)
         this.observableCreator = observableCreator
         this._observable$ = new Observable()
-        this._valueSubject$ = new BehaviorSubject(null)
-        this._errorSubject$ = new BehaviorSubject(null)
+        this._valueSubject$ = new BehaviorSubject(undefined)
+        this._errorSubject$ = new BehaviorSubject(undefined)
     }
 
     static autoDispose<S>(observableCreator: (ref: ProviderReference) => Observable<S>) {
         return new AutoDisposeObservableProvider<S>(observableCreator);
     }
 
-    static fromPromise<S>(promise: () => Promise<S>): ObservableProvider<S> {
-        return new ObservableProvider<S>(() => (from(promise()) as any))
-    }
-
     _compute() {
         this._observable$ = this.observableCreator()
         if(this._observable$ === null) {
             throw 'observableCreator cannot return null. It must return an instance of Observable'
         }
-        this._observable$.subscribe(
+        this._internalSubscription = this._observable$.subscribe(
             (val: T) => {
                 this._valueSubject$.next(val as any)
                 this._errorSubject$.next(null as any)