test(interface): add

Author: sciborrudnicki

packages/type/src/testing/interface/accessor-descriptor.interface.ts

@@ -0,0 +1,8 @@
+import { CommonDescriptor } from './common-descriptor.interface';
+/**
+ * Accessor descriptor with its unique `get` and `set` attributes and theirs generic `Value` type.
+ */
+export interface AccessorDescriptor<Value> extends CommonDescriptor {
+  get: (() => Value) | undefined;
+  set: ((value: Value) => void) | undefined;
+}

packages/type/src/testing/interface/common-descriptor.interface.ts

@@ -0,0 +1,7 @@
+/**
+ * Common `configurable` and `enumerable` of a `boolean` type attributes picked from default `PropertyDescriptor` for accessor and data
+ * descriptor.
+ * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperty
+ * "If a descriptor has neither of `value`, `writable`, `get` and `set` keys, it is treated as a data descriptor. "
+ */
+export interface CommonDescriptor extends Pick<PropertyDescriptor, 'configurable' | 'enumerable'> {}

packages/type/src/testing/interface/data-descriptor.interface.ts

@@ -0,0 +1,8 @@
+import { CommonDescriptor } from './common-descriptor.interface';
+/**
+ * Data descriptor with its unique `writable`, `value` attributes, and a generic `Value` type for the `value`.
+ */
+export interface DataDescriptor<Value> extends CommonDescriptor {
+  writable: boolean;
+  value: Value;
+}

packages/type/src/testing/interface/index.ts

@@ -0,0 +1,6 @@
+// Interface.
+export { AccessorDescriptor } from './accessor-descriptor.interface';
+export { DataDescriptor } from './data-descriptor.interface';
+export { CommonDescriptor } from './common-descriptor.interface';
+export { ObjectOne } from './object-one.interface';
+export { ObjectTwo } from './object-two.interface';

packages/type/src/testing/interface/object-one.interface.ts

@@ -0,0 +1,14 @@
+import { NUMBER } from '../variables/strict/number.const';
+import { STRING } from '../variables/strict/string.const';
+import { SYMBOL_NUMBER, SYMBOL_STRING } from '../variables/strict/symbol.const';
+
+export interface ObjectOne {
+  'key as string'?: boolean;
+  1030405027?: string;
+  5?: string;
+  [NUMBER]?: string;
+  [STRING]?: string;
+  [SYMBOL_NUMBER]?: string;
+  [SYMBOL_STRING]?: number;
+  x: number;
+}

packages/type/src/testing/interface/object-two.interface.ts

@@ -0,0 +1 @@
+export interface ObjectTwo { x: string; y: number; }

packages/type/src/testing/type/index.ts

@@ -0,0 +1 @@
+export { ThisAccessorDescriptor } from './this-accessor-descriptor.type';

packages/type/src/testing/type/this-accessor-descriptor.type.ts

@@ -0,0 +1,2 @@
+import { AccessorDescriptor } from '../interface/accessor-descriptor.interface';
+export type ThisAccessorDescriptor<Value, Obj = any> = AccessorDescriptor<Value> & ThisType<Obj>;