feat(api): add IClear interface

thi-ng · Dec 29, 2019 · 38f03ff · 38f03ff
1 parent f040eb5
commit 38f03ff
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/packages/api/src/api/clear.ts b/packages/api/src/api/clear.ts
@@ -0,0 +1,10 @@
+/**
+ * Interface for mutable types supporting internal cleanup (e.g.
+ * removing all values in a container etc.).
+ *
+ * @remarks
+ * Also see {@link IEmpty} and {@link IRelease} for related operations.
+ */
+export interface IClear {
+    clear(): void;
+}
diff --git a/packages/api/src/index.ts b/packages/api/src/index.ts
@@ -2,6 +2,7 @@ export * from "./api";
 export * from "./api/assoc";
 export * from "./api/bind";
 export * from "./api/buffered";
+export * from "./api/clear";
 export * from "./api/compare";
 export * from "./api/contains";
 export * from "./api/copy";