Variable defaultConst

    default: {
        add: ((user, workspace, project) => Promise<INewProject>);
        archive: ((project) => Promise<ReadStream>);
        copy: ((user, workspace, project) => Promise<undefined | INewProject>);
        del: ((workspace, project) => Promise<void>);
        deleteArchiveFile: ((project) => Promise<void>);
        get: (<T>(id, data) => Promise<undefined | IProjectGet<T>>);
        getWithData: (<T>(id, data) => Promise<undefined | IProjectWithData<T>>);
        unarchiveFromFile: ((project, buffer) => Promise<void>);
        unarchiveFromServer: ((project) => Promise<void>);
        update: ((project, data) => Promise<void>);
    } = ...

    Type declaration

    • add: ((user, workspace, project) => Promise<INewProject>)
        • (user, workspace, project): Promise<INewProject>
        • Add

          Parameters

          • user: {
                id: string;
            }

            User

            • id: string
          • workspace: {
                id: string;
            }

            Workspace

            • id: string
          • project: {
                description?: string;
                title: string;
            }

            Project

            • Optional description?: string
            • title: string

          Returns Promise<INewProject>

          New project

    • archive: ((project) => Promise<ReadStream>)
        • (project): Promise<ReadStream>
        • Archive

          Parameters

          • project: {
                id: string;
            }

            Project

            • id: string

          Returns Promise<ReadStream>

          Read stream

    • copy: ((user, workspace, project) => Promise<undefined | INewProject>)
        • (user, workspace, project): Promise<undefined | INewProject>
        • Copy

          Parameters

          • user: {
                id: string;
            }
            • id: string
          • workspace: {
                id: string;
            }

            Workspace

            • id: string
          • project: {
                id: string;
            }

            Project

            • id: string

          Returns Promise<undefined | INewProject>

    • del: ((workspace, project) => Promise<void>)
        • (workspace, project): Promise<void>
        • Delete

          Parameters

          • workspace: {
                id: string;
            }

            Workspace

            • id: string
          • project: {
                id: string;
            }

            Project

            • id: string

          Returns Promise<void>

    • deleteArchiveFile: ((project) => Promise<void>)
        • (project): Promise<void>
        • Delete archive file

          Parameters

          • project: {
                id: string;
            }

            Project

            • id: string

          Returns Promise<void>

    • get: (<T>(id, data) => Promise<undefined | IProjectGet<T>>)
    • getWithData: (<T>(id, data) => Promise<undefined | IProjectWithData<T>>)
    • unarchiveFromFile: ((project, buffer) => Promise<void>)
        • (project, buffer): Promise<void>
        • Unarchive from file

          Parameters

          • project: {
                id: string;
            }

            Project

            • id: string
          • buffer: Buffer

            Buffer

          Returns Promise<void>

    • unarchiveFromServer: ((project) => Promise<void>)
        • (project): Promise<void>
        • Unarchive from server

          Parameters

          • project: {
                id: string;
            }

            Project

            • id: string

          Returns Promise<void>

    • update: ((project, data) => Promise<void>)
        • (project, data): Promise<void>
        • Update

          Parameters

          • project: {
                id: string;
            }

            Project

            • id: string
          • data: any[]

            Data

          Returns Promise<void>

    Generated using TypeDoc and TypeDoc Airthium Plugin