跳到正文

Object 对象方法 API ​

本文逐项记录 @fast-china/utils 的 Object 对象公开函数。

isPlainObject 纯对象 ​

判断值是否是普通对象。

签名 ​

ts
export function isPlainObject(value: unknown): value is Record<PropertyKey, unknown>;

示例 ​

ts
import { isPlainObject } from "@fast-china/utils";

const result = isPlainObject({});

输入 ​

输入值输入值类型必填/默认值输入值说明
valueunknown是任意待检查值。

返回 ​

返回值返回值类型返回值说明
resultvalue is Record<PropertyKey, unknown>原型为 Object.prototype 或 null 时返回 true。

hasOwn 自有属性 ​

安全判断对象是否拥有自己的属性。

签名 ​

ts
export function hasOwn<ObjectType extends object, Key extends PropertyKey>(value: ObjectType, key: Key): key is Key & keyof ObjectType;

示例 ​

ts
import { hasOwn } from "@fast-china/utils";

const result = hasOwn({}, "profile");

输入 ​

输入值输入值类型必填/默认值输入值说明
valueObjectType是待检查对象。
keyKey是字符串、数字或 Symbol 属性键。

返回 ​

返回值返回值类型返回值说明
resultkey is Key & keyof ObjectType属性为对象自有属性时返回 true,并收窄键类型。

cloneDeep 克隆 ​

递归创建值的深层副本。

签名 ​

ts
export function cloneDeep<Value>(value: Value): Value;

示例 ​

ts
import { cloneDeep } from "@fast-china/utils";

const result = cloneDeep({});

输入 ​

输入值输入值类型必填/默认值输入值说明
valueValue是需要深复制的任意值。

返回 ​

返回值返回值类型返回值说明
resultValue与输入类型一致且不共享可克隆嵌套值的新值;原始类型直接返回自身。

isEqual 比较 ​

深度比较两个值是否等价。

签名 ​

ts
export function isEqual(left: unknown, right: unknown): boolean;

示例 ​

ts
import { isEqual } from "@fast-china/utils";

const result = isEqual([1, 2, 3], [2, 4]);

输入 ​

输入值输入值类型必填/默认值输入值说明
leftunknown是第一待比较值。
rightunknown是第二待比较值。

返回 ​

返回值返回值类型返回值说明
resultboolean两个值深度等价时返回 true。

pick 选取 ​

按键选取自有可枚举属性,返回浅复制对象,不修改源对象。

签名 ​

ts
export function pick<Source extends object, const Keys extends readonly (keyof Source)[]>(
	source: Source,
	keys: Keys
): number extends Keys["length"] ? Partial<Pick<Source, Keys[number]>> : Pick<Source, Keys[number]>;
export function pick<Source extends object>(source: Source, keys: readonly PropertyKey[]): Partial<Source>;

示例 ​

ts
import { pick } from "@fast-china/utils";

const result = pick({ id: 1, name: "Fast" }, ["id"] as const);

输入 ​

输入值输入值类型必填/默认值输入值说明
sourceSource是源对象或需处理的属性键;不修改输入。
keysreadonly PropertyKey[]是源对象或需处理的属性键;不修改输入。

返回 ​

返回值返回值类型返回值说明
resultPartial<Source>固定键元组保留精确类型;动态键数组中的候选键保持可选。嵌套值仍共享原引用。

omit 排除 ​

按键排除自有可枚举属性,返回浅复制对象,不修改源对象。

签名 ​

ts
export function omit<Source extends object, const Keys extends readonly (keyof Source)[]>(
	source: Source,
	keys: Keys
): number extends Keys["length"] ? Omit<Source, Keys[number]> & Partial<Pick<Source, Keys[number]>> : Omit<Source, Keys[number]>;
export function omit<Source extends object>(source: Source, keys: readonly PropertyKey[]): Partial<Source>;

示例 ​

ts
import { omit } from "@fast-china/utils";

const result = omit({ id: 1, name: "Fast" }, ["id"] as const);

输入 ​

输入值输入值类型必填/默认值输入值说明
sourceSource是源对象或需处理的属性键;不修改输入。
keysreadonly PropertyKey[]是源对象或需处理的属性键;不修改输入。

返回 ​

返回值返回值类型返回值说明
resultPartial<Source>固定键元组保留精确类型;动态键数组中的候选键保持可选。嵌套值仍共享原引用。

omitBy 排除 ​

按条件排除对象的自有可枚举属性。

签名 ​

ts
export function omitBy<Source extends object>(
	source: Source,
	predicate: (value: Source[keyof Source], key: keyof Source, source: Source) => unknown
): Partial<Source>;

示例 ​

ts
import { omitBy } from "@fast-china/utils";

const result = omitBy({ id: 1, name: "Fast" }, (_value, key) => key === "id");

输入 ​

输入值输入值类型必填/默认值输入值说明
sourceSource是不会被修改的源对象。
predicate(value: Source[keyof Source], key: keyof Source, source: Source) => unknown是接收属性值、键和源对象;返回真值时排除该属性。

返回 ​

返回值返回值类型返回值说明
resultPartial<Source>由未匹配属性组成的新对象。

pickBy 选取 ​

按条件选择对象的自有可枚举属性。

签名 ​

ts
export function pickBy<Source extends object>(
	source: Source,
	predicate: (value: Source[keyof Source], key: keyof Source, source: Source) => unknown
): Partial<Source>;

示例 ​

ts
import { pickBy } from "@fast-china/utils";

const result = pickBy({ id: 1, name: "Fast" }, (_value, key) => key === "name");

输入 ​

输入值输入值类型必填/默认值输入值说明
sourceSource是不会被修改的源对象。
predicate(value: Source[keyof Source], key: keyof Source, source: Source) => unknown是接收属性值、键和源对象;返回真值时保留该属性。

返回 ​

返回值返回值类型返回值说明
resultPartial<Source>由匹配属性组成的新对象。

mapValues 映射 ​

映射对象的自有可枚举属性值。

签名 ​

ts
export function mapValues<Source extends object, Result>(
	source: Source,
	mapper: (value: Source[keyof Source], key: keyof Source, source: Source) => Result
): { [Key in keyof Source]: Result };

示例 ​

ts
import { mapValues } from "@fast-china/utils";

const result = mapValues({ first: 1, second: 2 }, (value) => value * 2);

输入 ​

输入值输入值类型必填/默认值输入值说明
sourceSource是不会被修改的源对象。
mapper(value: Source[keyof Source], key: keyof Source, source: Source) => Result是接收值、键和源对象的映射函数。

返回 ​

返回值返回值类型返回值说明
result{ [Key in keyof Source]: Result }保留原键的新对象。

shallowEqual 比较 ​

对自有可枚举属性执行 SameValue 浅比较。

签名 ​

ts
export function shallowEqual(left: object, right: object): boolean;

示例 ​

ts
import { shallowEqual } from "@fast-china/utils";

const result = shallowEqual([1, 2, 3], [2, 4]);

输入 ​

输入值输入值类型必填/默认值输入值说明
leftobject是第一对象。
rightobject是第二对象。

返回 ​

返回值返回值类型返回值说明
resultboolean自有可枚举键集合与对应值均满足 SameValue 时返回 true。

toQueryString 查询串 ​

将对象序列化为标准 URL 查询字符串。

签名 ​

ts
export function toQueryString(value: Readonly<Record<string, QueryValue>>, options: QueryStringOptions = {}): string;

示例 ​

ts
import { toQueryString } from "@fast-china/utils";

const result = toQueryString({ page: 1, tag: ["vue", "tsx"] });

输入 ​

输入值输入值类型必填/默认值输入值说明
valueReadonly<Record<string, QueryValue>>是查询参数对象。
optionsQueryStringOptions否,默认 {}排序、空格和问号前缀选项。

返回 ​

返回值返回值类型返回值说明
resultstringURL 编码后的查询字符串;没有参数时始终返回空字符串。

复制与动态键边界 ​

深复制保留稀疏数组、自有可枚举字符串/Symbol 属性和循环关系;同一个 ArrayBuffer 的多个视图在副本内仍共享同一份新缓冲区,偏移与长度不变。不可克隆类型的既有处理合同不变。pick/omit 不进行深复制,动态键数组不再把可能缺失的键错误声明成必填。

查询编码边界 ​

toQueryString 使用原生 encodeURIComponent,并保留表单字符转义、默认 + 空格、space: "percent"、排序和问号前缀选项。键或值包含孤立 UTF-16 代理项时抛出 URIError,不再静默替换为 U+FFFD;非有限数字仍抛出 RangeError。