Home Reference Source

src/contacts-new/Contact.ts

import {User} from '../users-new/User';
import {ContactType} from './ContactType';
import {Email} from './Email';
import {Phone} from './Phone';

/**
 * @typedef {Object} ContactX Represents a contact. Look at {@link ContactRepository} documentation
 * to find the available ways to obtain objects adhering to this interface.
 * @property {string} id
 */

export type Contact = Readonly<{
	id: string;
	name: string;
	type: ContactType;
	phones: readonly Phone[];
	emails: readonly Email[];
	favorite: boolean;
	editable: boolean;
	user?: User;
}>;