mol_type_all 0.0.1827 → 0.0.1829

package/README.md

@@ -2,18 +2,18 @@
 
 Collection of TypeScript meta types for complex logic.
 
-![Type Asserts](https://i.imgur.com/CNI5KvX.png)
+# Usage
 
-# MAM Usage
+## MAM
 
 ```typescript
-type first_of_tuple = $mol_type_assert<
-	$mol_type_head<[ 1 , 2 , 3 ]> ,
-	1
+type cutted_head = $mol_type_assert<
+	$mol_type_tail<[ 1, 2, 3 ]>,
+	[ 2, 3 ]
 >
 ```
 
-# NPM usage
+## NPM
 
 ```sh
 npm install mol_type_all
@@ -21,17 +21,87 @@ npm install mol_type_all
 
 ```typescript
 import {
-	$mol_type_assert as Assert ,
-	$mol_type_head as Head ,
+	$mol_type_assert as Assert,
+	$mol_type_tail as Tail,
 } from 'mol_type_all'
 
-type first_of_tuple = Assert<
-	Head<[ 1 , 2 , 3 ]> ,
-	1
+type cutted_head = Assert<
+	Tail<[ 1, 2, 3 ]>,
+	[ 2, 3 ]
 >
 ```
 
-[![Edit $mol_type example](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/moltype-example-1ebxp)
+# Utilite types
+
+## Assertions
+
+- [$mol_type_error](./error) - special type for errors with details.
+- [$mol_type_assert](./assert) - fails type check on type inequality.
+- [$mol_type_enforce](./enforce) - fails type check on type incompatibility.
+
+```ts
+// Actual result
+type partial_record = $mol_type_assert<
+	Partial<{ foo: 123 }>, // Some expression
+	{ foo?: 123 } // Expected result
+>
+```
+
+![Type Asserts](https://habrastorage.org/webt/a4/d3/d6/a4d3d643f36e4ac3f431b9dac7a1f2c5.png)
+
+## Tuples
+
+- [$mol_type_head](./head) - first item of tuple or never.
+- [$mol_type_head_write](./head/write) - replaces first element of tuple.
+- [$mol_type_tail](./tail) - tuple without first item.
+- [$mol_type_foot](./foot) - last item of tuple or never.
+- [$mol_type_reverse](./reverse) - makes reversed tuple.
+
+## Algebraics
+
+- [$mol_type_equals](./equals) - check for types equality.
+- [$mol_type_access](./access) - takes type of property from wild union type.
+- [$mol_type_filter_keys](./filter/keys) - records from union with provided property.
+- [$mol_type_intersect](./intersect) - converts union to intersection.
+- [$mol_type_merge](./merge) - merges intersection of records to one record.
+- [$mol_type_keys_all](./keys/all) - all keys from all records from union.
+
+## Strings
+
+- [$mol_type_alphabet_*](./alphabet) - character classes.
+- [$mol_type_string_split](./string/split) - splits string by separator.
+- [$mol_type_string_join](./string/join) - joins strings by separator.
+
+## Numbers
+
+- [$mol_type_int_*](./int) - integer arithmetic (`+`, `-`, `*`, `/`, `^`, `..`, `()`, `<`)
+
+## Functions
+
+- [$mol_type_unary](./unary) - function/class with single param.
+- [$mol_type_param](./param) - takes param type by index.
+- [$mol_type_result](./result) - takes result/instance type.
+
+## Records
+
+- [$mol_type_immutable_deep](./immutable/deep) - recursive immutability.
+- [$mol_type_mutable_deep](./mutable/deep) - recursive mutability.
+- [$mol_type_partial_undefined](./partial/undefined) - makes all properties partial.
+- [$mol_type_partial_deep](./partial/deep) - makes all properties partial deeply.
+- [$mol_type_required_deep](./required/deep) - makes all properties required deeply.
+- [$mol_type_nullable](./nullable) - makes all properties nullable.
+- [$mol_type_writable](./writable) - makes all properties writable.
+- [$mol_type_keys_extract](./keys/extract) - extracts key names from record by value type.
+- [$mol_type_keys_exclude](./keys/exclude) - excludes key names from record by value type.
+- [$mol_type_omit](./omit) - omits properties by value type.
+- [$mol_type_pick](./pick) - pick properties by value type.
+- [$mol_type_override](./override) - fully replaces properties.
+- [$mol_type_case_*](./case) - converts keys/values to upper/lower/capital cases.
+
+- [$mol_type_flat_camel](./flat/camel) - makes flat record from volume records tree.
+- [$mol_type_flat_keys](./flat/keys) - takes keys paths from volume records tree.
+- [$mol_type_volume](./volume) - makes volume records tree from flat record.
+- [$mol_type_volume_value](./volume/value) - takes value from volume records tree by path.
 
 # Similar Projects