mark-3 0.0.4 → 0.0.5

package/helpers/string/trim/README.md

@@ -1,66 +0,0 @@
-# trim
-A small utility function to trim specific characters from both ends of a string.
-
-Unlike the native `String.prototype.trim()` which only removes whitespace, this function lets you specify exactly which characters to trim — including special characters or a list of them.
-
----
-
-## Features
-- Trim custom characters from the **start and end** of a string
-- Accepts either a **single character string** or an **array of characters**
-- Automatically escapes special regex characters
-- Ignores non-string input safely
-
----
-
-## Usage
-```js
-import { trim } from "mark-3/helpers/string";
-
-// Default whitespace trim
-trim("   Hello world   "); 
-// => "Hello world"
-
-// Trim specific character
-trim("---Hello---", "-"); 
-// => "Hello"
-
-// Trim multiple characters
-trim("..//Hello//..", [".", "/"]); 
-// => "Hello"
-
-// No trim if input is not a string
-trim(42, "-"); 
-// => 42
-
-// Empty trim characters (returns input as-is)
-trim("text", ""); 
-// => "text"
-
-// trim characters as a pattern
-trim(":::text:::_", ":::" ); 
-// => "text:::_"
-```
-
----
-
-## Parameters
-```ts
-trim(input: string, chars?: string | string[]): string
-```
-
-| Name  | Type                 | Default | Description                             |
-| ----- | -------------------- | ------- | --------------------------------------- |
-| input | `string`             | —       | The string to be trimmed                |
-| chars | `string \| string[]` | `" "`   | The character(s) to trim from both ends |
-
-If chars is a string of multiple characters, each character will be treated individually and removed if present at the start or end.
-
-**Behavior Details**
-If chars is an array: All characters in the array will be treated as individual characters to trim.
-
-If chars is a string:
-* A single-character string: trimmed directly like a single items array.
-* A multi-character string: each character as a whole.
-
-All special characters like ., *, +, ^ are automatically escaped — no need to handle them manually.

package/helpers/types/get-type-name/README.md

@@ -1,11 +0,0 @@
-# getTypeName
-Returns the name of a variable's type.
-
----
-
-## Usage
-```js
-import { getTypeName } from "mark-3/helpers/types";
-
-getTypeName({}); // 'Object'
-```

package/helpers/types/is-array/README.md

@@ -1,11 +0,0 @@
-# isArray
-Checks if a value is an array.
-
----
-
-## Usage
-```js
-import { isArray } from "mark-3/helpers/types";
-
-isArray([ 1, 2, 3 ]); // true
-```

package/helpers/types/is-empty/README.md

@@ -1,35 +0,0 @@
-# isEmpty
-Checks if the given variable is empty.
-
-If the variable is an object, it is considered empty if it has no keys.
-If the variable is an array, it is considered empty if it has no elements.
-If the variable is a map or a set, it is considered empty if it has no size.
-If the variable is a string, it is considered empty if it is trimmed to be an empty string.
-If the variable is undefined or null, it is considered empty.
-
-Otherwise, it is not considered empty.
-
----
-
-## Usage
-
-```js
-import { isEmpty } from 'mark-3/helpers/types/isEmpty';
-
-isEmpty( '' ); // true
-isEmpty( '     ' ); // true
-isEmpty([]); // true
-isEmpty({}); // true
-isEmpty( new Map()); // true
-isEmpty( new Set()); // true
-isEmpty( null ); // true
-isEmpty( undefined ); // true
-
-isEmpty( 'foo' ); // false
-isEmpty([ 'foo' ]); // false
-isEmpty({ foo: 'bar' }); // false
-isEmpty( new Map([ 'foo', 'bar' ])); // false
-isEmpty( new Set([ 'foo' ])); // false
-isEmpty({ foo: 'bar' }); // false
-isEmpty(() => {}); // false
-```

package/helpers/types/is-map/README.md

@@ -1,15 +0,0 @@
-# isMap
-Utility function to check if a value is a native `Map` object in JavaScript.
-
----
-
-## Usage
-```js
-import { isMap } from "@mark-3/helpers/types";
-
-isMap(new Map());     // true
-isMap(new WeakMap()); // false
-isMap({});            // false
-isMap([]);            // false
-isMap(null);          // false
-```

package/helpers/types/is-plain-object/README.md

@@ -1,17 +0,0 @@
-# isPlainObject
-A utility function to check if a value is a plain object.
-
-## Usage
-```js
-import { isPlainObject } from "mark-3/helpers/types";
-
-isPlainObject({});                       // true
-isPlainObject({ a: 1 });                 // true
-isPlainObject(Object.create(null));      // true
-isPlainObject([]);                       // false
-isPlainObject(null);                     // false
-isPlainObject(new Date());               // false
-isPlainObject(function(){});             // false
-isPlainObject(new Map());                // false
-isPlainObject(new ( class MyClass{})()); // false
-```

package/helpers/types/is-set/README.md

@@ -1,15 +0,0 @@
-# isSet
-Utility function to check if a value is a native `Set` object in JavaScript.
-
----
-
-## Usage
-```js
-import { isSet } from "mark-3/helpers/types";
-
-isSet(new Set());     // true
-isSet(new WeakSet()); // false
-isSet({});            // false
-isSet([]);            // false
-isSet(null);          // false
-```

package/helpers/types/is-string/README.md

@@ -1,12 +0,0 @@
-# isString
-Checks if a value is a string.
-
----
-
-## Usage
-```js
-import { isString } from "mark-3/helpers/types";
-
-isString( "foo" ); // true
-isString(1); // false
-```