feat: Added ExternalScope type.

mnasyrov · Aug 27, 2022 · 0e00d29 · 0e00d29
1 parent b560114
commit 0e00d29
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/packages/rx-effects/src/index.ts b/packages/rx-effects/src/index.ts
@@ -1,6 +1,9 @@
 export * from './action';
 export * from './effect';
-export * from './scope';
+
+export type { Scope, ExternalScope } from './scope';
+export { createScope } from './scope';
+
 export * from './controller';
 export * from './handleAction';
 export * from './stateDeclaration';

diff --git a/packages/rx-effects/src/scope.ts b/packages/rx-effects/src/scope.ts
@@ -9,7 +9,7 @@ import { createStore, Store, StoreOptions } from './store';
 /**
  * A controller-like boundary for effects and business logic.
  *
- * It collects all subscriptions which are made by child entities and provides
+ * `Scope` collects all subscriptions which are made by child entities and provides
  * `destroy()` method to unsubscribe from them.
  */
 export type Scope = Controller<{
@@ -64,6 +64,11 @@ export type Scope = Controller<{
   ) => Effect<Event, Result, ErrorType>;
 }>;
 
+/**
+ * `ExternalScope` and `Scope` types allow to distinct which third-party code can invoke `destroy()` method.
+ */
+export type ExternalScope = Omit<Scope, 'destroy'>;
+
 /**
  * Creates `Scope` instance.
  */