generator-begcode/dist/lib/types/base/relationship.d.ts

Spring Boot + Angular/React/Vue in one handy generator

/**
 * Copyright 2013-2025 the original author or authors from the JHipster project.
 *
 * This file is part of the JHipster project, see https://www.jhipster.tech/
 * for more information.
 *
 * 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
 *
 *      https://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.
 */

import type { Property } from './property.js';

export type Relationship = Property & {
  relationshipName: string;
  otherEntityName: string;
  relationshipType: 'one-to-one' | 'one-to-many' | 'many-to-one' | 'many-to-many';

  relationshipSide?: 'left' | 'right';
  otherEntityRelationshipName?: string;
  otherEntityField?: string;

  options?: Record<string, boolean | string | number | any>;
};