Skip to main content

Deno Transformer

Based on Golang Transformer

Building Transformers

import * as Transform from "https://deno.land/x/transform/mod.ts";

const ATransformer: Transform.Transformer =  {
   reset() {
      // To reset internal state
      // it is called by: newReader
   },
   async transform(src: Uint8Array, dst: Deno.Writer, atEOF: boolean): Promise<number | null> {
       const transformed = new TextEncoder().encode("a".repeat(src.length));
       await Deno.writeAll(dst, transformed);
       return transformed.length;
   }
}

Built-in Transformers

Base64

Base64Decoder

import * as Transform from "https://deno.land/x/transform/mod.ts";
const { Base64Decoder } = Transform.Transformers;

const input = await Deno.open('./image.b64', { read: true });
const output = await Deno.open('./image.png', { create: true, write: true });
const reader = Transform.newReader(input, new Base64Decoder());
await Deno.copy(reader, output);
input.close();
output.close();

Base64Encoder

import * as Transform from "https://deno.land/x/transform/mod.ts";
const { Base64Encoder } = Transform.Transformers;

const input = await Deno.open('./image.png', { read: true });
const output = await Deno.open('./image.b64', { create: true, write: true });
const reader = Transform.newReader(input, new Base64Encoder);
await Deno.copy(reader, output);
input.close();
output.close();

Zlib

GzEncoder

import { Untar } from "https://deno.land/std/archive/tar.ts";
import * as Transform from "https://deno.land/x/transform/mod.ts";
const { GzEncoder } = Transform.Transformers;

const tar = new Tar();
const content = new TextEncoder().encode("Deno.land");
await tar.append("deno.txt", {
  reader:  new  Deno.Buffer(content),
  contentSize: content.byteLength,
});

const output = await Deno.open('file.tar.gz', { write: true, create: true });
await Transform.pipeline(tar.getReader(), new GzEncoder())
  .to(output);

output.close()

GzDecoder

import { tar } from "https://deno.land/std/archive/tar.ts";
import * as Transform from "https://deno.land/x/transform/mod.ts";
const { GzDecoder } = Transform.Transformers;

const input = await Deno.open('file.tar.gz', { read: true });
const untar = new Untar(
  Transform.newReader(input, new GzDecoder())
);

for await (const entry of untar) {
  console.log(entry);
}

API

newReader(r: Reader, t: Transformer): Reader

Returns a new Reader that wraps r by transforming the bytes read via t. It calls t.reset().

import * as Transform from "https://deno.land/x/transform/mod.ts";

/* ... */

const file = await Deno.open('file.txt'); // deno.land
const reader = Transform.newReader(
    file,
    ATransformer
);
assertEquals(
    new TextDecoder().decode(await Deno.readAll(reader)),
    'aaaaaaaaa'
);
file.close()

chain(...t: Transformer[]): Transformer

Returns a Transformer that applies t in sequence.

import * as Transform from "https://deno.land/x/transform/mod.ts";
const { Base64Decoder, Base64Encoder } = Transform.Transformers;

const expected = await Deno.readFile('./image.png');
const input = await Deno.open('./image.png', { read: true });

const transformer = Transform.chain(new Base64Encoder(), new Base64Decoder())
const reader = Transform.newReader(input, transformer);

assertEquals(expected,  await Deno.readAll(reader))
input.close();

pipeline(r: Reader, ...t: Transformer[]): Reader

A wrapper around Transformer.chain & Transformer.newReader

import * as Transform from "https://deno.land/x/transform/mod.ts";
const { Base64Decoder, Base64Encoder } = Transform.Transformers;

const expected = await Deno.readFile('./image.png');
const input = await Deno.open('./image.png', { read: true });
const output = await Deno.open('./image.b64', { read: true });

// const reader = await Transform.pipeline(input, new Base64Encoder())

await Transform.pipeline(input, new Base64Encoder())
  .to(writer)

output.close();
input.close()