Type alias AddCodeComponentParams

AddCodeComponentParams: {
    cid: string;
    language: string;
    name: string;
    path: string;
    starred: boolean;
    subtype: ResearchObjectComponentCodeSubtype;
}

Parameters for adding code component to manifest. These can be nested in layers to mark subdirectories as other types of code, etc.

Type declaration

  • cid: string

    CID of the target file or unixFS directory

  • language: string
  • name: string

    Human-readable name of the code collection

  • path: string

    Absolute path to the code in the drive

  • starred: boolean

    Wether to show the document as a central component of the object

  • subtype: ResearchObjectComponentCodeSubtype

    Indicates the type of document

Settings

Member Visibility

Theme

Generated using TypeDoc