@pdfme/pdf-lib/dist/esm/__tests__/core/objects/PDFArray.spec.js

Create and modify PDF files with JavaScript

import { PDFArray, PDFBool, PDFContext, PDFDict, PDFHexString, PDFName, PDFNull, PDFNumber, PDFRef, PDFString, } from '../../../src/core';
import { toCharCode, typedArrayFor } from '../../../src/utils';
describe(`PDFArray`, () => {
    const context = PDFContext.create();
    it(`can be constructed with PDFArray.withContext(...)`, () => {
        expect(PDFArray.withContext(context)).toBeInstanceOf(PDFArray);
    });
    const pdfArray = PDFArray.withContext(context);
    const pdfBool = PDFBool.True;
    const pdfHexString = PDFHexString.of('ABC123');
    const pdfName = PDFName.of('Foo#Bar!');
    const pdfNull = PDFNull;
    const pdfNumber = PDFNumber.of(-24.179);
    const pdfString = PDFString.of('foobar');
    const pdfSubDict = PDFDict.withContext(context);
    pdfSubDict.set(PDFName.of('Foo'), PDFName.of('Bar'));
    const pdfSubArray = PDFArray.withContext(context);
    pdfSubArray.push(PDFBool.True);
    pdfSubArray.push(pdfSubDict);
    const pdfRef = PDFRef.of(21, 92);
    pdfArray.push(pdfBool);
    pdfArray.push(pdfHexString);
    pdfArray.push(pdfName);
    pdfArray.push(pdfNull);
    pdfArray.push(pdfNumber);
    pdfArray.push(pdfString);
    pdfArray.push(pdfSubArray);
    pdfArray.push(pdfRef);
    it(`retains pushed objects`, () => {
        expect(pdfArray.size()).toBe(8);
        expect(pdfArray.get(0)).toBe(pdfBool);
        expect(pdfArray.get(1)).toBe(pdfHexString);
        expect(pdfArray.get(2)).toBe(pdfName);
        expect(pdfArray.get(3)).toBe(pdfNull);
        expect(pdfArray.get(4)).toBe(pdfNumber);
        expect(pdfArray.get(5)).toBe(pdfString);
        expect(pdfArray.get(6)).toBe(pdfSubArray);
        expect(pdfArray.get(7)).toBe(pdfRef);
    });
    it(`allows objects to be assigned to specific indices`, () => {
        const array = PDFArray.withContext(PDFContext.create());
        array.push(PDFName.of('a'));
        array.push(PDFName.of('b'));
        array.push(PDFName.of('c'));
        array.set(1, PDFName.of('z'));
        expect(array.get(1)).toBe(PDFName.of('z'));
        expect(array.size()).toBe(3);
    });
    it(`allows objects to be inserted at specific indices`, () => {
        const array = PDFArray.withContext(PDFContext.create());
        array.push(PDFName.of('a'));
        array.push(PDFName.of('b'));
        array.push(PDFName.of('c'));
        array.insert(1, PDFName.of('z'));
        expect(array.get(0)).toBe(PDFName.of('a'));
        expect(array.get(1)).toBe(PDFName.of('z'));
        expect(array.get(2)).toBe(PDFName.of('b'));
        expect(array.size()).toBe(4);
    });
    it(`allows objects to be removed from specific indices`, () => {
        const array = PDFArray.withContext(PDFContext.create());
        array.push(PDFName.of('a'));
        array.push(PDFName.of('b'));
        array.push(PDFName.of('c'));
        array.remove(1);
        expect(array.get(0)).toBe(PDFName.of('a'));
        expect(array.get(1)).toBe(PDFName.of('c'));
        expect(array.size()).toBe(2);
    });
    it(`can be converted to an Array`, () => {
        expect(pdfArray.asArray()).toEqual([
            pdfBool,
            pdfHexString,
            pdfName,
            pdfNull,
            pdfNumber,
            pdfString,
            pdfSubArray,
            pdfRef,
        ]);
    });
    it(`can be cloned`, () => {
        const original = pdfArray;
        const clone = original.clone();
        expect(clone).not.toBe(original);
        expect(clone.toString()).toBe(original.toString());
    });
    it(`can be converted to a string`, () => {
        expect(String(pdfArray)).toBe('[ true <ABC123> /Foo#23Bar! null -24.179 (foobar) [ true <<\n/Foo /Bar\n>> ] 21 92 R ]');
    });
    it(`can provide its size in bytes`, () => {
        expect(pdfArray.sizeInBytes()).toBe(84);
    });
    it(`can be serialized`, () => {
        const buffer = new Uint8Array(88).fill(toCharCode(' '));
        expect(pdfArray.copyBytesInto(buffer, 3)).toBe(84);
        expect(buffer).toEqual(typedArrayFor('   [ true <ABC123> /Foo#23Bar! null -24.179 (foobar) [ true <<\n/Foo /Bar\n>> ] 21 92 R ] '));
    });
});
//# sourceMappingURL=PDFArray.spec.js.map