@technobuddha/library/chop/chop.ts

A large library of useful functions

import { empty }  from '../constants';
import isFinite from 'lodash/isFinite';

export type Options = {
    /** If true, the last block will be omitted if has insufficient characters **/
    truncate?: boolean;
};

/**
 * Break a string into equal sized segments of characters
 *
 * @param input The string to break apart
 * @param length The length of each segment
 * @returns Array of segments
 */
export function chop(input: string, length: number, { truncate = false }: Options = {}): string[] {
    // eslint-disable-next-line @typescript-eslint/prefer-regexp-exec
    return length > 0 && isFinite(length) ? input.match(new RegExp(`.{${truncate ? empty : '1,'}${length}}`, 'gu')) as string[] : [ input ];
}

export default chop;