@arun_murali/rustyutils v1.0.11

📘 Function Documentation

Introduction

Welcome to the function documentation for our project! This document provides detailed descriptions, parameters, return values, and example usages for all available functions. It is designed to help you understand how each function works and how to use them in your projects. Below you'll find a table of contents that links to each function’s detailed documentation.

Table of Contents

• deep_clone()
• flatten()
• hash_value()
• compare_hash()
• chunk()

deep_clone()

Description: Creates a deep copy of the given input.

Example usage:

const cloned = deep_clone({ key: 'value' });
console.log(cloned); // Output: { key: 'value' }

Parameters

Returns

flatten()

Description: Flattens a nested object or array into a single-level object with dot-separated keys.

Example usage:

const flattened = flatten({ 'a.b.c': 1 });
console.log(flattened); // Output: { 'a.b.c': 1 }

Parameters

Returns

hash_value()

Description: Generates a hash of the input string using the specified algorithm.

Example usage:

const hash = hash_value('hello world', 'sha256');
console.log(hash); // Output: e.g. '64ec88ca00b268e5ba1a35678a1b5316d212f4f366b2477246bfe2f30e6e5aef'

Parameters

Returns

compare_hash()

Description: Compares an input string against a given hash using the specified algorithm.

Example usage:

const isValid = compare_hash('hello world', 'sha256', '64ec88ca00b268e5ba1a35678a1b5316d212f4f366b2477246bfe2f30e6e5aef');
console.log(isValid); // Output: true

Parameters

Returns

chunk()

Description: Splits an input array into smaller chunks of a specified size.

Example usage:

const result = chunk([1, 2, 3, 4, 5], 2);
console.log(result); // Output: [[1, 2], [3, 4], [5]]

Parameters

Returns