@craftercms/studio-ui/utils/array.d.ts

Services, components, models & utils to build CrafterCMS authoring extensions.

/*
 * Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import LookupTable from '../models/LookupTable';
import { PagedArray } from '../models';
export declare function forEach<T = any, R = undefined>(
  array: T[],
  fn: (item: T, index: number, array: T[]) => R | 'continue' | 'break' | undefined,
  emptyReturnValue?: R
): R;
export declare function asArray<T = unknown>(value: T | T[]): T[];
export declare function createPresenceTable(list: string[]): LookupTable<boolean>;
export declare function createPresenceTable<T extends string | number | boolean>(
  list: string[],
  value: T
): LookupTable<T>;
export declare function createPresenceTable<T extends any>(
  list: string[],
  valueGenerator: (listItem: string) => T
): LookupTable<T>;
export declare function createPresenceTable<T extends any = boolean, K extends any = ''>(
  list: K[],
  valueOrGenerator: string | number | boolean | ((listItem: string) => T),
  itemKeyGenerator: (value: K) => string
): LookupTable<T>;
/**
 * Receives two different arrays of string, it will combine it selecting one string of the first array
 * and then other string of the second array, until there are no more strings
 * @param a
 * @param b
 */
export declare function mergeArraysAlternatively(a: string[], b: string[]): string[];
export declare function createPagedArray<T = any>(array: T[], response: any): PagedArray<T>;