Parsifly logo

Parsifly Docs

API Reference

IProject

Documentation for IProject (256)

parsifly-extension-base / index / IProject

Interface: IProject<GType>

Defined in: lib/data-providers/interfaces/IProject.ts:10

Extends

Type Parameters

GType

GType extends TProjectType

Properties

components

components: (IComponent | IFolder<IComponent>)[]

Defined in: lib/data-providers/interfaces/IProject.ts:26

Used to list all components of the project

description

description: string | null

Defined in: lib/data-providers/interfaces/IBase.ts:23

Used to describe some more specific detail

Inherited from

IBase.description

id

id: string

Defined in: lib/data-providers/interfaces/IBase.ts:7

Uuid used as identifier

Inherited from

IBase.id

name

name: string

Defined in: lib/data-providers/interfaces/IBase.ts:19

Used to identify a record more simply.

  • Can't have space
  • Cannot have special characters
  • It cannot be empty

Inherited from

IBase.name

pages

pages: (IPage | IFolder<IPage>)[]

Defined in: lib/data-providers/interfaces/IProject.ts:22

Used to list all pages of the project

public

public: boolean

Defined in: lib/data-providers/interfaces/IProject.ts:18

Used to define if this record is public or not

services

services: (IService | IFolder<IService>)[]

Defined in: lib/data-providers/interfaces/IProject.ts:30

Used to list all services of the project

type

type: GType

Defined in: lib/data-providers/interfaces/IBase.ts:11

Used for tree it helps to know what type of item is this

Inherited from

IBase.type

version

version: string

Defined in: lib/data-providers/interfaces/IProject.ts:14

Version of the package