@piplup/utils

!npm bundle size

This package contains a set of utility functions and React hooks designed to simplify common tasks and enhance your development experience. Below is an overview of each helper function and hook, along with usage examples.

Installation

``bash
npm install @piplup/utils
`

or

`bash
yarn add @piplup/utils
`

or

`bash
pnpm add @piplup/utils
`

Table of Contents

- Helpers
- compact
- execSequentially
- hasOwnProperty
- setRef
- forkRef
- Hooks
- useEventCallback
- useEventListener
- useForkRef
- useIsomorphicEffect
- useLocalStorage

Helpers

$3

Removes all falsey values from an array.

#### Example

`tsx
import { compact } from '@piplup/utils';

const result = compact([0, 1, false, 2, '', 3]);
// => [1, 2, 3]
`

$3

Executes a series of functions sequentially with the same arguments.

#### Example

`tsx
import { execSequentially } from '@piplup/utils';

const log1 = (message: string) => console.log(Log1: ${message});
const log2 = (message: string) => console.log(Log2: ${message});

const executeLogs = execSequentially(log1, log2);
executeLogs('Hello');
// Output:
// Log1: Hello
// Log2: Hello
`

$3

Checks if an object has a property with the specified key.

#### Example

`tsx
import { hasOwnProperty } from '@piplup/utils';

const obj = { key: 'value' };

if (hasOwnProperty(obj, 'key')) {
console.log(obj.key); // Output: 'value'
}
`

$3

Sets a React ref or callback ref to a specified value.

#### Example

`tsx
import { setRef } from '@piplup/utils';

const ref = React.createRef();

setRef(ref, document.createElement('div'));
`

$3

Creates a function that forwards an instance to multiple refs.

$3

`tsx
import * as React from 'react';
import { forkRef } from '@piplup/utils';

type TextInputProps = React.InputHTMLAttributes;

function TextInputComponent(props: TextInputProps, ref?: React.Ref) {
const internalRef = React.useRef(null);

// Combine internalRef and ref received from parent component
const handleInputRef = React.useMemo(() => forkRef(internalRef, ref), []);

return (
placeholder="Type something here"
{...props}
ref={handleInputRef} // Pass the combined ref to the input
/>
);
}

const TextFieldInput = React.forwardRef(TextInputComponent);

export default TextFieldInput;
`

Hooks

$3

Returns a stable callback function that always refers to the latest version of the passed function.

#### Example

`tsx
import { useEventCallback } from '@piplup/utils';

const MyComponent = () => {
const handleClick = useEventCallback(() => {
console.log('Clicked!');
});

return Click me;
};
`

$3

A hook for listening to events in react.

#### Example

`tsx
import { useEventListener } from '@piplup/utils';

const MyComponent = () => {
useEventListener('resize', () => {
console.log('Window resized');
});

return

;
};
`

$3

Combines multiple refs into a single ref callback.

#### Example

`tsx
import { useForkRef } from '@piplup/utils';

const MyComponent = () => {
const ref1 = React.useRef(null);
const ref2 = React.useRef(null);

const forkedRef = useForkRef(ref1, ref2);

return

;
};
`

$3

A hook that uses useLayoutEffect on the client side and useEffect on the server side.

#### Example

`tsx
import { useIsomorphicEffect } from '@piplup/utils';

const MyComponent = () => {
useIsomorphicEffect(() => {
console.log('Effect runs on the client side');
}, []);

return

;
};
`

$3

A hook for reading value stored in localStorage

#### Example

`tsx
import { useLocalStorage, setItem, removeItem } from '@piplup/utils';

const MyComponent = () => {
const [value, setValue] = useLocalStorage('myKey', 'initialValue');

return (



);
};
``