weseek__growi/packages/core/src/interfaces/common.ts

/*
 * Common types and interfaces
 */

import type { HasObjectId } from './has-object-id';


// Foreign key field
export type Ref<T> = string | T & HasObjectId;

export type Nullable<T> = T | null | undefined;

export const isPopulated = <T>(ref: T & HasObjectId | Ref<T>): ref is T & HasObjectId => {
  return !(typeof ref === 'string');
};

export const getIdForRef = <T>(ref: T & HasObjectId | Ref<T>): string => {
  return isPopulated(ref)
    ? ref._id
    : ref;
};