Comparing version 1.16.9 to 1.17.9
@@ -21,3 +21,3 @@ # Array Utility Functions Documentation | ||
```typescript | ||
import { filterArray } from 'auxin'; | ||
const { filterArray } = require('auxin'); | ||
@@ -45,3 +45,3 @@ const arr = [1, 2, 3, 4, 5]; | ||
```typescript | ||
import { mapArray } from 'auxin'; | ||
const { mapArray } = require('auxin'); | ||
@@ -69,3 +69,3 @@ const arr = [1, 2, 3, 4, 5]; | ||
```typescript | ||
import { binarySearch } from 'auxin'; | ||
const { binarySearch } = require('auxin'); | ||
@@ -92,3 +92,3 @@ const arr = [1, 2, 3, 4, 5]; | ||
```typescript | ||
import { quickSort } from 'auxin'; | ||
const { quickSort } = require('auxin'); | ||
@@ -116,3 +116,3 @@ const arr = [3, 1, 4, 1, 5, 9, 2, 6, 5]; | ||
```typescript | ||
import { arrPush } from 'auxin'; | ||
const { arrPush } = require('auxin'); | ||
@@ -140,3 +140,3 @@ let arr = [1, 2, 3]; | ||
```typescript | ||
import { arrUnshift } from 'auxin'; | ||
const { arrUnshift } = require('auxin'); | ||
@@ -163,3 +163,3 @@ let arr = [2, 3, 4]; | ||
```typescript | ||
import { arrPop } from 'auxin'; | ||
const { arrPop } = require('auxin'); | ||
@@ -186,3 +186,3 @@ let arr = [1, 2, 3]; | ||
```typescript | ||
import { arrShift } from 'auxin'; | ||
const { arrShift } = require('auxin'); | ||
@@ -211,3 +211,3 @@ let arr = [1, 2, 3]; | ||
```typescript | ||
import { arrSlice } from 'auxin'; | ||
const { arrSlice } = require('auxin'); | ||
@@ -234,3 +234,3 @@ const arr = [1, 2, 3, 4, 5]; | ||
```typescript | ||
import { arrToUpperCase } from 'auxin'; | ||
const { arrToUpperCase } = require('auxin'); | ||
@@ -257,3 +257,3 @@ const arr = ['hello', 'world']; | ||
```typescript | ||
import { arrToLowerCase } from 'auxin'; | ||
const { arrToLowerCase } = require('auxin'); | ||
@@ -272,3 +272,3 @@ const arr = ['HELLO', 'WORLD']; | ||
```typescript | ||
import * as arrayUtils from 'auxin'; | ||
const arrayUtils = require('auxin'); | ||
@@ -295,3 +295,3 @@ const arr = [1, 2, 3, 4, 5]; | ||
```typescript | ||
import { quickSortDescending } from 'auxin'; | ||
const { quickSortDescending } = require('auxin'); | ||
@@ -309,2 +309,2 @@ const arr = [3, 1, 4, 1, 5, 9, 2, 6, 5]; | ||
</div> | ||
</div> |
# Date Utility Functions Documentation | ||
This npm package provides several utility functions for working with dates in TypeScript. Below are the details of each function along with code examples for usage. | ||
This npm package offers various utility functions for managing dates in TypeScript. Below, you'll find detailed descriptions of each function along with code examples demonstrating their usage. | ||
## `formatDate` | ||
Formats a date object as a string in the specified format. | ||
This function formats a date object into a string based on the provided format. | ||
@@ -21,3 +21,3 @@ ### Parameters | ||
```typescript | ||
import { formatDate } from 'auxin'; | ||
const { formatDate } = require('auxin'); | ||
@@ -31,3 +31,3 @@ const date = new Date(); | ||
Gets the current date and time formatted as a string in the specified format. | ||
This function retrieves the current date and time formatted as a string according to the specified format. | ||
@@ -45,3 +45,3 @@ ### Parameters | ||
```typescript | ||
import { getCurrentDateTime } from 'auxin'; | ||
const { getCurrentDateTime } = require('auxin'); | ||
@@ -54,3 +54,3 @@ const formattedDateTime = getCurrentDateTime('YYYY-MM-DD HH:mm:ss'); | ||
Parses a date string into a Date object. | ||
This function parses a date string and returns a Date object. | ||
@@ -68,3 +68,3 @@ ### Parameters | ||
```typescript | ||
import { parseDate } from 'auxin'; | ||
const { parseDate } = require('auxin'); | ||
@@ -78,3 +78,3 @@ const dateString = '2024-04-21'; | ||
Checks if a given year is a leap year. | ||
This function checks if a given year is a leap year. | ||
@@ -92,3 +92,3 @@ ### Parameters | ||
```typescript | ||
import { isLeapYear } from 'auxin'; | ||
const { isLeapYear } = require('auxin'); | ||
@@ -95,0 +95,0 @@ const year = 2024; |
# String Utility Functions Documentation | ||
This npm package provides several utility functions for working with strings in TypeScript. Below are the details of each function along with code examples for usage. | ||
This npm package offers various utility functions for manipulating strings in TypeScript. Below, you'll find detailed descriptions of each function along with code examples demonstrating their usage. | ||
## `capitalize` | ||
Converts the first character of a string to uppercase. | ||
This function converts the first character of a string to uppercase. | ||
@@ -20,7 +20,7 @@ ### Parameters | ||
```typescript | ||
import { capitalize } from 'auxin'; | ||
const { capitalize } = require('stringUtils'); | ||
const str = 'hello'; | ||
const str = 'hello world'; | ||
const capitalizedStr = capitalize(str); | ||
console.log(capitalizedStr); // Output: 'Hello' | ||
console.log(capitalizedStr); // Output: 'Hello world' | ||
``` | ||
@@ -30,3 +30,3 @@ | ||
Converts the first character of a string to lowercase. | ||
This function converts the first character of a string to lowercase. | ||
@@ -44,7 +44,7 @@ ### Parameters | ||
```typescript | ||
import { decapitalize } from 'auxin'; | ||
const { decapitalize } = require('stringUtils'); | ||
const str = 'Hello'; | ||
const str = 'Hello World'; | ||
const decapitalizedStr = decapitalize(str); | ||
console.log(decapitalizedStr); // Output: 'hello' | ||
console.log(decapitalizedStr); // Output: 'hello World' | ||
``` | ||
@@ -54,3 +54,3 @@ | ||
Converts a string to lowercase. | ||
This function converts all characters in a string to lowercase. | ||
@@ -63,3 +63,3 @@ ### Parameters | ||
The lowercase version of the string. | ||
The string with all characters in lowercase. | ||
@@ -69,7 +69,7 @@ ### Example | ||
```typescript | ||
import { toLowerCase } from 'auxin'; | ||
const { toLowerCase } = require('stringUtils'); | ||
const str = 'HELLO'; | ||
const str = 'Hello World'; | ||
const lowerCaseStr = toLowerCase(str); | ||
console.log(lowerCaseStr); // Output: 'hello' | ||
console.log(lowerCaseStr); // Output: 'hello world' | ||
``` | ||
@@ -79,3 +79,3 @@ | ||
Converts a string to uppercase. | ||
This function converts all characters in a string to uppercase. | ||
@@ -88,3 +88,3 @@ ### Parameters | ||
The uppercase version of the string. | ||
The string with all characters in uppercase. | ||
@@ -94,7 +94,7 @@ ### Example | ||
```typescript | ||
import { toUpperCase } from 'auxin'; | ||
const { toUpperCase } = require('stringUtils'); | ||
const str = 'hello'; | ||
const str = 'hello world'; | ||
const upperCaseStr = toUpperCase(str); | ||
console.log(upperCaseStr); // Output: 'HELLO' | ||
console.log(upperCaseStr); // Output: 'HELLO WORLD' | ||
``` | ||
@@ -104,3 +104,3 @@ | ||
Removes leading and trailing whitespace from a string. | ||
This function removes leading and trailing whitespace from a string. | ||
@@ -118,7 +118,7 @@ ### Parameters | ||
```typescript | ||
import { trim } from 'auxin'; | ||
const { trim } = require('stringUtils'); | ||
const str = ' hello '; | ||
const str = ' hello world '; | ||
const trimmedStr = trim(str); | ||
console.log(trimmedStr); // Output: 'hello' | ||
console.log(trimmedStr); // Output: 'hello world' | ||
``` | ||
@@ -128,3 +128,3 @@ | ||
Checks if a string starts with the specified prefix. | ||
This function checks if a string starts with the specified prefix. | ||
@@ -143,6 +143,6 @@ ### Parameters | ||
```typescript | ||
import { startsWith } from 'auxin'; | ||
const { startsWith } = require('stringUtils'); | ||
const str = 'hello'; | ||
const prefix = 'he'; | ||
const str = 'hello world'; | ||
const prefix = 'hello'; | ||
const startsWithPrefix = startsWith(str, prefix); | ||
@@ -154,3 +154,3 @@ console.log(startsWithPrefix); // Output: true | ||
Checks if a string ends with the specified suffix. | ||
This function checks if a string ends with the specified suffix. | ||
@@ -169,6 +169,6 @@ ### Parameters | ||
```typescript | ||
import { endsWith } from 'auxin'; | ||
const { endsWith } = require('stringUtils'); | ||
const str = 'hello'; | ||
const suffix = 'lo'; | ||
const str = 'hello world'; | ||
const suffix = 'world'; | ||
const endsWithSuffix = endsWith(str, suffix); | ||
@@ -180,3 +180,3 @@ console.log(endsWithSuffix); // Output: true | ||
Reverses a string. | ||
This function reverses a string. | ||
@@ -194,7 +194,7 @@ ### Parameters | ||
```typescript | ||
import { reverseStr } from 'auxin'; | ||
const { reverseStr } = require('stringUtils'); | ||
const str = 'hello'; | ||
const str = 'hello world'; | ||
const reversedStr = reverseStr(str); | ||
console.log(reversedStr); // Output: 'olleh' | ||
console.log(reversedStr); // Output: 'dlrow olleh' | ||
``` | ||
@@ -204,3 +204,3 @@ | ||
Counts the occurrences of a substring within a string. | ||
This function counts the occurrences of a substring within a string. | ||
@@ -219,8 +219,8 @@ ### Parameters | ||
```typescript | ||
import { countOccurrences } from 'auxin'; | ||
const { countOccurrences } = require('stringUtils'); | ||
const str = 'hello world hello'; | ||
const str = 'hello world hello hello'; | ||
const subStr = 'hello'; | ||
const occurrences = countOccurrences(str, subStr); | ||
console.log(occurrences); // Output: 2 | ||
console.log(occurrences); // Output: 3 | ||
``` | ||
@@ -234,2 +234,2 @@ | ||
</div> | ||
</div> |
{ | ||
"name": "auxin", | ||
"version": "1.16.9", | ||
"version": "1.17.9", | ||
"description": "Auxin is a powerful Node.js utility toolkit that simplifies common tasks, boosting your development productivity.", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
96096