/* README.md */

bluebird-helpers

bluebird-helpers is a collection of reusable React and React Native hooks designed to simplify utility operations across various domains, including date manipulation, string handling, validation, and UI behaviors. Whether you need to format dates, validate inputs, or manipulate strings, this library provides easy-to-use hooks for developers to streamline their work and avoid reinventing the wheel.

Key Features

Date Utilities: Includes functions for formatting and manipulating dates (e.g., relative day calculations, date suffixes, and multiple date formats).

String Utilities: Offers functions for string manipulation like checking emptiness, trimming, case conversion, and special character detection.

Optimized Performance: Memoized functions ensure minimal recalculations and improved performance, especially in re-render-heavy applications.

Simple Integration: Easy to install and integrate into any React/React Native project.

Installation

npm install bluebird-helpers

or

yarn add bluebird-helpers

Available Hooks

useDateUtils Hook

A custom React hook that provides various utility functions to manipulate and format dates. It allows you to get date suffixes, calculate relative days (like "Today", "Tomorrow", "Yesterday"), and format dates in multiple styles.

Usage:

Functions

getDateInDDMMYYYY

Returns a formatted date in the DD/MM/YYYY format.

Example

/**
 *getDateInDDMonthYYYY
 * @param {number} dateTimeStamp
 * @returns {DateString} Date in dd/mm/yyyy
 */
import { useDateUtils } from "bluebird-helpers";
const { getDateInDDMMYYYY } = useDateUtils();
const formattedDate = getDateInDDMMYYYY(1633017600000);
console.log(formattedDate); // Output: '01/10/2021'

/**
 * getDateInReverseKebabCase
 * @param {number} dateTimeStamp
 * @returns {LocalDate} Date in yyyy-mm--dd
 */
const { getDateInReverseKebabCase } = useDateUtils();
const formattedDate = getDateInReverseKebabCase(1633017600000);
console.log(formattedDate); // Output: '2021-10-05'

/**
 * getDateInSentence
 * @param {number} dateTimeStamp
 * @returns {DateString} Date in 08th November 2024
 */
const { getDateInSentence } = useDateUtils();
const sentenceDate = getDateInSentence(1633017600000);
console.log(sentenceDate); // Output: '1st October 2021'

/**
 * getRelativeDay
 * @param {number} dateTimeStamp
 * @returns {DateString} Day relative to today e.g Today, Tomorrow, Yesterday
 */
const { getRelativeDay } = useDateUtils();
const relativeDay = getRelativeDay(1633017600000);
console.log(relativeDay); // Output: 'Today' (if the date is today) or 1m (if called after 1 minute)

/**
 * Get date suffix e.g. "st" in 21st
 * @param {number} date - date of a month gotten from date.getDate()
 * @returns {'st' | 'nd' | 'rd' | 'th'}
 */
export const formatDate = dateString => {
  const date = new Date(dateString);

  return (
    getRelativeDay(dateString) ||
    dayjs(dateString).format(`dddd, D[${getDateSuffix(date)}] MMMM`)
  );
};

useStringUtils Hook

Description

A custom React hook that provides various utility functions to manipulate strings. It allows you to check if a string is empty, trim whitespace, convert to upper or lowercase, and capitalize the first letter.

Functions

isEmpty

Returns true if the string is empty or only contains whitespace, and false otherwise.

Example

import { useStringUtils } from "bluebird-helpers";
const { isEmpty } = useStringUtils();
const result = isEmpty('   ');
console.log(result); // Output: true```

### `trimString`
Returns the string with leading and trailing whitespace removed.

const { trimString } = useStringUtils();
const trimmed = trimString('  hello  ');
console.log(trimmed); // Output: 'hello'


### `toUpperCase`
Returns the string with leading and trailing whitespace removed.

const { toUpperCase } = useStringUtils();
const upper = toUpperCase('hello');
console.log(upper); // Output: 'HELLO'


### `toLowerCase`
Returns the string with leading and trailing whitespace removed.

const { toLowerCase } = useStringUtils();
const lower = toLowerCase('HELLO');
console.log(lower); // Output: 'hello'


### `capitalizeFirstLetter`
Returns the string with the first letter capitalized.

const { capitalizeFirstLetter } = useStringUtils();
const capitalized = capitalizeFirstLetter('hello');
console.log(capitalized); // Output: 'Hello'


### `hasSpecialCharacter`
Checks if the string contains any special characters (e.g., !@#$%^&*).

const { hasSpecialCharacter } = useStringUtils();
console.log(hasSpecialCharacter('Hello@World')); // true
console.log(hasSpecialCharacter('HelloWorld')); // false

### `maskSensitiveInfo`
Checks

const { maskSensitiveInfo } = useStringUtils();
console.log(maskSensitiveInfo("1234567890")); // ******7890

### `isValidEmail`
Checks if the email is valid.

const { isValidEmail } = useStringUtils();
console.log(isValidEmail("[email protected]")); // true

### Check to sanitize input (remove dangerous characters)
const { sanitizeInput } = useStringUtils();

console.log(sanitizeInput('<script>alert("x")</script>')); // scriptalert("x")script

### `isValidCardNumber`
Checks if the cardNumber is valid.

const { isValidCardNumber } = useStringUtils();
console.log(isValidCardNumber('4111 1111 1111 1111')); // true

### `validvalidatePasswordStrength`
const { validvalidatePasswordStrength } = useStringUtils();

console.log(validvalidatePasswordStrength('MyStr0ngP@ss!')); // true

### `slugify`
Replace spaces and non-word characters with hyphens

const { slugify } = useStringUtils();
console.log(slugify("Hello World! This is a test.")); // Output: "hello-world-this-is-a-test"

### `generateReferenceID`
Generate reference id 

const { generateReferenceID } = useStringUtils();
console.log(generateReferenceID("TXN")); // "TXN-k7j6f-8xk3"

### `calculateAgeFromDOB`
calculate age from Date of birth
const { calculateAgeFromDOB } = useStringUtils();
console.log(calculateAgeFromDOB("1997-04-20")); // e.g., 28

Contributing

Feel free to open issues or PRs for new utility suggestions or improvements.

License

MIT