JavaScript-Bibliothek common/base64

Diese Bibliothek bietet Funktionen zum Kodieren und Dekodieren von Daten im Base64-Format. Sie eignet sich für das Umwandeln von Binärdaten und Streams in Base64-kodierte Strings und zurück.

Verwendung

Binden Sie die Bibliothek stets am Anfang eines Skripts ein:

let base64 = require('common/base64');

Funktionen

encode

Kodiert ein Byte-Array oder einen agorum.InputStream zu einem Base64-codierten String.

Syntax

base64.encode(bytesOrStream);

Parameter

Parameter	Beschreibung	Pflicht	Standard
bytesOrStream	Zu kodierende Daten. Akzeptiert: byte[] agorum.InputStream Es muss sich zwingend entweder um ein Java-Byte-Array (byte[]) oder um ein InputStream-Objekt handeln.	ja	–

Beispiel

let base64 = require('common/base64');
let objects = require('common/objects');

let inputDoc = objects.find('/agorum/roi/Files/Demo/Willkommen.pdf');

let encodedData = base64.encode(inputDoc.contentStream);

Rückgabewerte

Der Rückgabewert ist ein base64-codierter String.

encodeUtf8String

Kodiert einen UTF-8-String direkt zu einem Base64-codierten String. Diese Funktion ist besonders nützlich, wenn Textdaten (etwa JSON, XML oder einfache Strings) Base64-kodiert übertragen oder gespeichert werden sollen.

Syntax

base64.encodeUtf8String(string);

Parameter

Parameter	Beschreibung	Pflicht	Standard
string	UTF-8-String, der kodiert werden soll	ja	–

Beispiel für Text

let base64 = require('common/base64');

let myText = 'Hallo agorum core! Dies ist ein Test mit Umlauten: äöü';

let encodedText = base64.encodeUtf8String(myText);

encodedText;

Beispiel für JSON

let base64 = require('common/base64');

let jsonData = JSON.stringify({ name: 'Test §$% äöü', value: 123 });
let encodedJson = base64.encodeUtf8String(jsonData);

encodedJson;

 

Rückgabewerte

Der Rückgabewert ist ein base64-codierter String.

decodeToBytes

Dekodiert einen Base64-codierten String zurück zu einem Byte-Array.

Syntax

base64.decodeToBytes(encoded);

Parameter

Parameter	Beschreibung	Pflicht	Standard
encoded	Base64-codierter String	ja	–

Beispiel

let base64 = require('common/base64');
let objects = require('common/objects');

let inputDoc = objects.find('/agorum/roi/Files/Demo/Willkommen.pdf');

let encodedData = base64.encode(inputDoc.contentStream);

let bytes = base64.decodeToBytes(encoded);

Rückgabewerte

Der Rückgabewert ist ein Byte-Array (byte[]).

decodeToStream

Dekodiert einen Base64-codierten String zu einem InputStream.

Syntax

base64.decodeToStream(encodedData);

Parameter

Parameter	Beschreibung	Pflicht	Standard
encoded	Base64-codierter String	ja	–

Beispiel

let base64 = require('common/base64');
let objects = require('common/objects');

let inputDoc = objects.find('/agorum/roi/Files/Demo/Willkommen.pdf');
let targetfolder = objects.find('/Home/roi/MyFiles');

let encodedData = base64.encode(inputDoc.contentStream);

let stream = base64.decodeToStream(encodedData);

let file = objects.create('file', {
  name: 'decodedWillkommenDoc.pdf',
  content: stream,
  description: 'Eine dekodierte Datei',
  target: targetfolder,
});

file;

Rückgabewerte

Der Rückgabewert ist ein InputStream-Objekt.