Method isPrimaryKey

packages/core/src/utils/Utils.ts:424–444

* Checks whether the argument looks like primary key (string, number or ObjectId).

(key: any, allowComposite = false)

   * Checks whether the argument looks like primary key (string, number or ObjectId).
   */
  static isPrimaryKey<T>(key: any, allowComposite = false): key is Primary<T> {
    if (['string', 'number', 'bigint'].includes(typeof key)) {
      return true;
    }

    if (allowComposite && Array.isArray(key) && key.every(v => Utils.isPrimaryKey(v, true))) {
      return true;
    }

    if (Utils.isObject(key)) {
      if (key.constructor?.name === 'ObjectId') {
        return true;
      }

      if (!Utils.isPlainObject(key) && !Utils.isEntity(key, true)) {
        return true;
      }
    }

    return false;
  }

  /**
   * Extracts primary key from `data`. Accepts objects or primary keys directly.