mark-3 0.0.3 → 0.0.5

package/helpers/date/format/README.md

@@ -1,33 +0,0 @@
-# format
-A lightweight and flexible date formatting utility for JavaScript and TypeScript. This helper formats Date objects using PHP-style tokens like Y, m, d, H, i, and more. It supports both short and long month names with locale-aware formatting via Intl.DateTimeFormat.
-
-Built with simplicity and clarity in mind — no external dependencies, easy to use, fully typed.
-
----
-
-## Usage
-```ts
-import { format } from '@mark-3/helpers/date';
-
-format( new Date, "Y-m-d H:i:s" );
-// 2022-01-01 22:00:00 (mysql datetime format)
-
-format( new Date, "j MM, H:i", "tr" );
-// 1 Temmuz, 22:00
-```
-
----
-
-## 💡 Supported Tokens
-`d`: 01-31 (zero-padded day)
-`j`:  1-31 (non-padded day)
-`m`: 01-12 (zero-padded month)
-`n`:  1-12 (non-padded month)
-`M`: Jan–Dec (short month name, localized)
-`MM`: January–December (long month name, localized)
-`y`: 00-99 (two-digit year)
-`Y`: 0000-9999 (full year)
-`H`: 00-23 (zero-padded hour, 24h)
-`G`:  0-23 (hour, 24h)
-`i`: 00-59 (minutes)
-`s`: 00-59 (seconds)

package/helpers/date/format/index.test.js

@@ -1,97 +0,0 @@
-import { describe, it, expect } from "vitest";
-import formatDate from "./index";
-
-describe( "formatDate", () =>
-{
-	const date = new Date( "2025-12-21T22:10:05" );
-
-	it( "formats full year (Y)", () =>
-	{
-		expect( formatDate( date, "Y" )).toBe( "2025" );
-	});
-	
-	it( "formats short year (y)", () =>
-	{
-		expect( formatDate( date, "y" )).toBe( "25" );
-	});
-	
-	it( "formats zero-padded month (m)", () =>
-	{
-		expect( formatDate( date, "m" )).toBe( "12" );
-	});
-	
-	it( "formats non-padded month (n)", () =>
-	{
-		expect( formatDate( date, "n" )).toBe( "12" );
-	});
-	
-	it( "formats short month name (M)", () =>
-	{
-		expect( formatDate( date, "M" )).toBe( "Dec" );
-	});
-	
-	it( "formats full month name (MM)", () =>
-	{
-		expect( formatDate( date, "MM" )).toBe( "December" );
-	});
-	
-	it( "formats day padded (d)", () =>
-	{
-		expect( formatDate( date, "d" )).toBe( "21" );
-	});
-	
-	it( "formats day non-padded (j)", () =>
-	{
-		expect( formatDate( date, "j" )).toBe( "21" );
-	});
-	
-	it( "formats zero-padded hour (H)", () =>
-	{
-		expect( formatDate( date, "H" )).toBe( "22" );
-	});
-	
-	it( "formats non-padded hour (G)", () =>
-	{
-		expect( formatDate( date, "G" )).toBe( "22" );
-	});
-	
-	it( "formats minutes (i)", () =>
-	{
-		expect( formatDate( date, "i" )).toBe( "10" );
-	});
-	
-	it( "formats seconds (s)", () =>
-	{
-		expect( formatDate( date, "s" )).toBe( "05" );
-	});
-	
-	it( "formats a custom pattern", () =>
-	{
-		expect( formatDate( date, "d.m.Y H:i" )).toBe( "21.12.2025 22:10" );
-	});
-	
-	it( "supports localized short month (M) in TR", () =>
-	{
-		expect( formatDate( date, "M", "tr" )).toBe( "Ara" ); // Aralık
-	});
-	
-	it( "supports localized long month (MM) in TR", () =>
-	{
-		expect( formatDate( date, "MM", "tr" )).toBe( "Aralık" );
-	});
-	
-	it( "returns empty string for empty pattern", () =>
-	{
-		expect( formatDate( date, "" )).toBe( "" );
-	});
-	
-	it( "leaves unknown tokens as-is", () =>
-	{
-		expect( formatDate( date, "[foo] Y" )).toBe( "[foo] 2025" );
-	});
-	
-	it( "mixes plain text and tokens", () =>
-	{
-		expect( formatDate( date, "d MM Y, H:i" )).toBe( "21 December 2025, 22:10" );
-	});
-});

package/helpers/date/from-timestamp/README.md

@@ -1,14 +0,0 @@
-# fromTimestamp
-This function handles both seconds and milliseconds timestamps by checking the length of the number.
-
-If the `timestamp` is less than `1e11`, it's assumed to be in seconds and is converted to milliseconds. If the conversion results in an invalid `Date` object, the function returns the provided `defaultValue`
-or `undefined` if no default is specified.
-
----
-
-## Usage
-```ts
-import fromTimestamp from '@mark-3/helpers-date-from-timestamp';
-
-const result = fromTimestamp( 1753634780845 );
-```

package/helpers/date/is-on-same-day/README.md

@@ -1,12 +0,0 @@
-# isOnSameDay
-A lightweight utility to check whether two JavaScript `Date` objects are in the same calendar day.
-
----
-
-## Usage
-```ts
-import isOnSameDay from '@mark-3/helpers-date-is-on-same-day';
-
-const result = isOnSameDay( new Date( '2022-01-01' ), new Date( '2022-12-31' ));
-// false
-```

package/helpers/date/is-on-same-year/README.md

@@ -1,13 +0,0 @@
-# isOnSameYear
-A lightweight utility to check whether two JavaScript `Date` objects are in the same calendar year.
-
----
-
-## Usage
-
-```ts
-import isOnSameYear from '@mark-3/helpers-date-is-on-same-year';
-
-const result = isOnSameYear( new Date( '2022-01-01' ), new Date( '2022-12-31' ));
-// true
-```

package/helpers/string/camel-to-dash/README.md

@@ -1,24 +0,0 @@
-# camelToDash
-Converts a camelCase string to dash-case.
-
-* replaces uppercase letters with a dash followed by the lowercase equivalent
-* removes leading and trailing dashes
-* if the input is not a string, returns it unchanged
-
----
-
-## Usage
-```js
-import { camelToDash } from "mark-3/helpers/string";
-
-camelToDash("helloWorld");       // "hello-world"
-camelToDash("backgroundColor");  // "background-color"
-camelToDash("already-dashed");   // "already-dashed"
-camelToDash("already---dashed"); // "already---dashed"
-camelToDash("MyComponent");      // "my-component"
-camelToDash("XMLHttpRequest");   // "x-m-l-http-request"
-camelToDash("someValue123");     // "some-value123"
-camelToDash("---EdgeCase---");   // "edge-case"
-camelToDash(42);                 // 42
-camelToDash(null);               // null
-```

package/helpers/string/escape-regex/README.md

@@ -1,12 +0,0 @@
-# escapeRegex
-Escapes special characters in a string to be used in a regular expression.
-
----
-
-## Usage
-```js
-import { escapeRegex } from "mark-3/helpers/string";
-
-escapeRegex( "foo" );  // => "foo"
-escapeRegex( "foo*" ); // => "foo\*"
-```

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-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-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
-```

package/helpers/types/is-string/index.test.js

@@ -1,46 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import isString from './isString'; // dosya yolunu kendi yapına göre düzenle
-
-describe('isString', () => {
-  it('should return true for a normal string', () => {
-    expect(isString('hello')).toBe(true);
-  });
-
-  it('should return true for an empty string', () => {
-    expect(isString('')).toBe(true);
-  });
-
-  it('should return false for a String object', () => {
-    // typeof new String('abc') === 'object'
-    expect(isString(new String('abc'))).toBe(false);
-  });
-
-  it('should return false for a number', () => {
-    expect(isString(123)).toBe(false);
-  });
-
-  it('should return false for null', () => {
-    expect(isString(null)).toBe(false);
-  });
-
-  it('should return false for undefined', () => {
-    expect(isString(undefined)).toBe(false);
-  });
-
-  it('should return false for an object', () => {
-    expect(isString({})).toBe(false);
-  });
-
-  it('should return false for an array', () => {
-    expect(isString(['a', 'b'])).toBe(false);
-  });
-
-  it('should return false for a boolean', () => {
-    expect(isString(true)).toBe(false);
-    expect(isString(false)).toBe(false);
-  });
-
-  it('should return false for a function', () => {
-    expect(isString(() => {})).toBe(false);
-  });
-});