@armscye/core 0.1.0 → 0.3.0

package/README.md

@@ -1,6 +1,6 @@
 # @armscye/core
 
-> A collection of shared standard TypeScript definitions.
+> A collection of shared standard TypeScript definitions (@core).
 
 ## Installation
 
@@ -15,3 +15,41 @@ or using yarn:
 ```sh
 yarn add @armscye/core --dev
 ```
+
+## Reference
+
+### Abstract `Interface`
+
+Represents an abstract class `T`, if applied to a concrete class it would stop being instantiable.
+
+```ts
+interface Abstract<T = any> extends Function {
+  prototype: T;
+}
+```
+
+### NoArgument `Interface`
+
+Represents an instantiable class `T` with a default (no-argument) constructor.
+
+```ts
+interface NoArgument<T = any> extends Function {
+  new (): T;
+}
+```
+
+### Type `Interface`
+
+Represents an instantiable class `T` with constructor parameters.
+
+```ts
+interface Type<T = any> extends Function {
+  new (...args: any[]): T;
+}
+```
+
+## License
+
+This project is licensed under the **MIT license**.
+
+See [LICENSE](LICENSE) for more information.

package/dist/{abstract.interface.d.ts → abstract.d.ts}

@@ -2,6 +2,6 @@
  * Represents an abstract class `T`, if applied to a concrete class it would stop being
  * instantiable.
  */
-export interface Abstract<T> extends Function {
+export interface Abstract<T = any> extends Function {
     prototype: T;
 }

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export * from './abstract.interface';
-export * from './no-argument.interface';
-export * from './type.interface';
+export * from './abstract';
+export * from './no-argumen';
+export * from './type';

package/dist/no-argumen.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Represents an instantiable class `T` with a default (no-argument) constructor.
+ */
+export interface NoArgument<T = any> extends Function {
+    new (): T;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@armscye/core",
-  "version": "0.1.0",
-  "description": "A collection of shared standard TypeScript definitions",
+  "version": "0.3.0",
+  "description": "A collection of shared standard TypeScript definitions (@core)",
   "author": "Augustus Kamau",
   "license": "MIT",
   "types": "./dist/index.d.ts",
@@ -11,7 +11,8 @@
   "keywords": [
     "armscye",
     "typescript",
-    "types"
+    "types",
+    "core"
   ],
   "homepage": "https://github.com/armscye/armscye#readme",
   "repository": {
@@ -24,5 +25,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "052fa1099c964068feda456b787214c025533e6c"
+  "gitHead": "a26e3829ccbd43eae0ab1a1dd165af7ae7b355c1"
 }

package/dist/no-argument.interface.d.ts

@@ -1,6 +0,0 @@
-/**
- * Represents an instantiable class `T` that doesn't require arguments to the constructor.
- */
-export interface NoArgument<T = any> extends Function {
-    new (): T;
-}