// (C) Copyright 2015 Moodle Pty Ltd. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. export type CoreObjectWithoutEmpty = { [k in keyof T]: T[k] extends undefined | null ? never : T[k]; }; export type CoreObjectWithoutUndefined = { [k in keyof T]: T[k] extends undefined ? never : T[k]; }; /** * Singleton with helper functions for objects. */ export class CoreObject { /** * Check if two objects have the same shape and the same leaf values. * * @param a First object. * @param b Second object. * @return Whether objects are equal. */ static deepEquals(a: unknown, b: unknown): boolean { return JSON.stringify(a) === JSON.stringify(b); } /** * Check whether the given object is empty. * * @param object Object. * @return Whether the given object is empty. */ static isEmpty(object: Record): boolean { return Object.keys(object).length === 0; } /** * Create a new object without the specified keys. * * @param obj Object. * @param keys Keys to remove from the new object. * @return New object without the specified keys. */ static without(obj: T, keys: K[]): Omit { const newObject: T = { ...obj }; for (const key of keys) { delete newObject[key]; } return newObject; } /** * Create a new object without empty values (null or undefined). * * @param obj Objet. * @return New object without empty values. */ static withoutEmpty(obj: T): CoreObjectWithoutEmpty { const cleanObj = {}; for (const [key, value] of Object.entries(obj)) { if (value === null || value === undefined) { continue; } cleanObj[key] = value; } return cleanObj as CoreObjectWithoutEmpty; } /** * Create a new object without undefined values. * * @param obj Objet. * @return New object without undefined values. */ static withoutUndefined(obj: T): CoreObjectWithoutUndefined { const cleanObj = {}; for (const [key, value] of Object.entries(obj)) { if (value === undefined) { continue; } cleanObj[key] = value; } return cleanObj as CoreObjectWithoutUndefined; } }