@v4fire/core/src/core/prelude/object/helpers.ts

V4Fire core library

/*!
 * V4Fire Core
 * https://github.com/V4Fire/Core
 *
 * Released under the MIT license
 * https://github.com/V4Fire/Core/blob/master/LICENSE
 */

import type { GetTypeType } from 'core/prelude/object/interface';

/**
 * Returns true if the specified value is a container structure
 * @param value
 */
export function isContainer(value: unknown): boolean {
	if (!Object.isTruly(value) || typeof value !== 'object') {
		return false;
	}

	if (Object.isArray(value) || Object.isDictionary(value) || Object.isMap(value) || Object.isSet(value)) {
		return true;
	}

	return Object.isCustomObject(value!.constructor);
}

/**
 * Returns true if the specified value has a prototype that can be extended
 * @param value
 */
export function canExtendProto(value: unknown): boolean {
	if (!Object.isTruly(value) || typeof value !== 'object') {
		return false;
	}

	if (Object.isArray(value) || Object.isDictionary(value)) {
		return true;
	}

	return Object.isCustomObject(value!.constructor);
}

/**
 * Returns a type of the specified value
 * @param value
 */
export function getType(value: unknown): GetTypeType {
	if (value == null || typeof value !== 'object') {
		return '';
	}

	if (Object.isArray(value)) {
		return 'array';
	}

	if (Object.isArrayLike(value)) {
		return 'arrayLike';
	}

	if (Object.isMap(value)) {
		return 'map';
	}

	if (Object.isWeakMap(value)) {
		return 'weakMap';
	}

	if (Object.isSet(value)) {
		return 'set';
	}

	if (Object.isWeakSet(value)) {
		return 'weakSet';
	}

	return 'object';
}

/**
 * Returns a new instance of the specified value or null
 * @param value
 */
export function getSameAs<T>(value: T): Nullable<T> {
	let
		res: unknown = null;

	if (value != null && typeof value === 'object') {
		if (Object.isArray(value)) {
			res = [];

		} else if (Object.isDictionary(value)) {
			res = Object.getPrototypeOf(value) == null ? Object.create(null) : {};

		} else if (Object.isMap(value)) {
			res = new Map();

		} else if (Object.isSet(value)) {
			res = new Set();

		} else if (Object.isCustomObject(Object.cast<object>(value).constructor)) {
			res = {};
		}
	}

	return Object.cast(res);
}