@stencila/types/src/types/Cite.ts

JavaScript classes and TypeScript types for the Stencila Schema

// Generated file; do not edit. See https://github.com/stencila/stencila/tree/main/rust/schema-gen

import { CitationIntent } from "./CitationIntent.js";
import { CitationMode } from "./CitationMode.js";
import { Entity } from "./Entity.js";
import { Inline } from "./Inline.js";
import { IntegerOrString } from "./IntegerOrString.js";

/**
 * A reference to a `CreativeWork` that is cited in another `CreativeWork`.
 */
export class Cite extends Entity {
  // @ts-expect-error 'not assignable to the same property in base type'
  type: "Cite";

  /**
   * The target of the citation (URL or reference ID).
   */
  target: string;

  /**
   * Determines how the citation is shown within the surrounding text.
   */
  citationMode: CitationMode;

  /**
   * The type/s of the citation, both factually and rhetorically.
   */
  citationIntent?: CitationIntent[];

  /**
   * Optional structured content/text of this citation.
   */
  content?: Inline[];

  /**
   * The page on which the work starts; for example "135" or "xiii".
   */
  pageStart?: IntegerOrString;

  /**
   * The page on which the work ends; for example "138" or "xvi".
   */
  pageEnd?: IntegerOrString;

  /**
   * Any description of pages that is not separated into pageStart and pageEnd; for example, "1-6, 9, 55".
   */
  pagination?: string;

  /**
   * Text to show before the citation.
   */
  citationPrefix?: string;

  /**
   * Text to show after the citation.
   */
  citationSuffix?: string;

  constructor(target: string, citationMode: CitationMode, options?: Partial<Cite>) {
    super();
    this.type = "Cite";
    if (options) Object.assign(this, options);
    this.target = target;
    this.citationMode = citationMode;
  }
}

/**
* Create a new `Cite`
*/
export function cite(target: string, citationMode: CitationMode, options?: Partial<Cite>): Cite {
  return new Cite(target, citationMode, options);
}