effect-libreoffice-workspace
    Preparing search index...

    Interface LibreOffice

    interface LibreOffice {
        closeDocument: (
            sessionId: string,
        ) => Effect<Option<Uint8Array<ArrayBufferLike>>, LibreOfficeError>;
        convert: (
            input: Uint8Array,
            options: ConversionOptions,
            filename?: string,
        ) => Effect<ConversionResult, LibreOfficeError>;
        editorOperation: <T = unknown>(
            sessionId: string,
            method: string,
            args?: unknown[],
        ) => Effect<EditorOperationResult<T>, LibreOfficeError>;
        getDocumentInfo: (
            input: Uint8Array,
            options: InputFormatOptions,
        ) => Effect<DocumentInfo, LibreOfficeError>;
        getDocumentText: (
            input: Uint8Array,
            inputFormat: string,
        ) => Effect<Option<string>, LibreOfficeError>;
        getPageCount: (
            input: Uint8Array,
            options: InputFormatOptions,
        ) => Effect<number, LibreOfficeError>;
        getPageNames: (
            input: Uint8Array,
            inputFormat: string,
        ) => Effect<string[], LibreOfficeError>;
        openDocument: (
            input: Uint8Array,
            options: InputFormatOptions,
        ) => Effect<EditorSession, LibreOfficeError>;
        renderPage: (
            input: Uint8Array,
            options: InputFormatOptions,
            pageIndex: number,
            width: number,
            height?: number,
        ) => Effect<PagePreview, LibreOfficeError>;
        renderPageFullQuality: (
            input: Uint8Array,
            options: InputFormatOptions,
            pageIndex: number,
            renderOptions?: FullQualityRenderOptions,
        ) => Effect<FullQualityPagePreview, LibreOfficeError>;
        renderPagePreviews: (
            input: Uint8Array,
            options: InputFormatOptions,
            renderOptions?: RenderOptions,
        ) => Effect<PagePreview[], LibreOfficeError>;
    }
    Index

    Properties

    closeDocument convert editorOperation getDocumentInfo getDocumentText getPageCount getPageNames openDocument renderPage renderPageFullQuality renderPagePreviews

    Properties

    closeDocument: (
        sessionId: string,
    ) => Effect<Option<Uint8Array<ArrayBufferLike>>, LibreOfficeError>

    Close an editor session and get the modified document

    2.0.0

    convert: (
        input: Uint8Array,
        options: ConversionOptions,
        filename?: string,
    ) => Effect<ConversionResult, LibreOfficeError>

    Convert a document to a different format

    2.0.0

    editorOperation: <T = unknown>(
        sessionId: string,
        method: string,
        args?: unknown[],
    ) => Effect<EditorOperationResult<T>, LibreOfficeError>

    Execute an editor operation on an open document session

    2.0.0

    getDocumentInfo: (
        input: Uint8Array,
        options: InputFormatOptions,
    ) => Effect<DocumentInfo, LibreOfficeError>

    Get document information including type and valid output formats

    2.0.0

    getDocumentText: (
        input: Uint8Array,
        inputFormat: string,
    ) => Effect<Option<string>, LibreOfficeError>

    Extract text content from a document

    2.0.0

    getPageCount: (
        input: Uint8Array,
        options: InputFormatOptions,
    ) => Effect<number, LibreOfficeError>

    Get the number of pages/parts in a document

    2.0.0

    getPageNames: (
        input: Uint8Array,
        inputFormat: string,
    ) => Effect<string[], LibreOfficeError>

    Get page/slide names from a document

    2.0.0

    openDocument: (
        input: Uint8Array,
        options: InputFormatOptions,
    ) => Effect<EditorSession, LibreOfficeError>

    Open a document for editing Returns a session ID that can be used for subsequent editor operations

    2.0.0

    renderPage: (
        input: Uint8Array,
        options: InputFormatOptions,
        pageIndex: number,
        width: number,
        height?: number,
    ) => Effect<PagePreview, LibreOfficeError>

    Render a single page as an image

    2.0.0

    renderPageFullQuality: (
        input: Uint8Array,
        options: InputFormatOptions,
        pageIndex: number,
        renderOptions?: FullQualityRenderOptions,
    ) => Effect<FullQualityPagePreview, LibreOfficeError>

    Render a page at full quality (native resolution based on DPI)

    2.0.0

    renderPagePreviews: (
        input: Uint8Array,
        options: InputFormatOptions,
        renderOptions?: RenderOptions,
    ) => Effect<PagePreview[], LibreOfficeError>

    Render multiple page previews

    2.0.0

    Settings

    Member Visibility

    On This Page

    Properties