@stencila/types/src/types/Link.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 { Entity } from "./Entity.js";
import { Inline } from "./Inline.js";

/**
 * A hyperlink to other pages, sections within the same document, resources, or any URL.
 */
export class Link extends Entity {
  // @ts-expect-error 'not assignable to the same property in base type'
  type: "Link";

  /**
   * The textual content of the link.
   */
  content: Inline[];

  /**
   * The target of the link.
   */
  target: string;

  /**
   * A title for the link.
   */
  title?: string;

  /**
   * The relation between the target and the current thing.
   */
  rel?: string;

  constructor(content: Inline[], target: string, options?: Partial<Link>) {
    super();
    this.type = "Link";
    if (options) Object.assign(this, options);
    this.content = content;
    this.target = target;
  }
}

/**
* Create a new `Link`
*/
export function link(content: Inline[], target: string, options?: Partial<Link>): Link {
  return new Link(content, target, options);
}