Fire's Utils

A package for myself for my more common things that I don't want to reimplement everywhere

Table of Contents

• Installation
• Usage
  • Awaiter
  • Random Number Generator
  • Capitalize Words
  • Create Pages
• License

Installation

To install you can use npm or yarn (or whatever package manager you use):

npm install fires-utils
# or
yarn add fires-utils

Usage

Awaiter

The awaiter function is used to handle async/await errors gracefully. It wraps a promise and returns an object with either the resolved data or the caught error.

import { awaiter, Result } from 'fires-utils';

async function fetchData(): Promise<Result<MyDataType>> {
    const result = await awaiter(fetch('https://api.example.com/data'));
    if (result.error) {
        console.error('Error fetching data:', result.error);
        return;
    }
    console.log('Fetched data:', result.data);
    return result;
}

Random Number Generator

The random function generates a random number between a specified range, inclusive.

import { random } from 'fires-utils';

const min = 1;
const max = 10;
const randomNumber = random(min, max);
console.log(`Random number between ${min} and ${max}:`, randomNumber);

Capitalize Words

The uppercaseWords function capitalizes the first letter of each word in a string.

import { uppercaseWords } from 'fires-utils';

const sentence = 'hello world';
const capitalizedSentence = uppercaseWords(sentence);
console.log('Capitalized sentence:', capitalizedSentence);

Create Pages

The createPages function takes an array and divides it into smaller arrays of a specified size.

import { createPages } from 'fires-utils';

const items = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
const pageSize = 3;
const pages = createPages(items, pageSize);
console.log('Pages:', pages);

License

This project is licensed under the MIT License. See the LICENSE file for details.