Uint8Array.prototype.setFromBase64()
Die setFromBase64()
Methode von Uint8Array
Instanzen füllt dieses Uint8Array
Objekt mit Bytes aus einem Base64-codierten String und gibt ein Objekt zurück, das angibt, wie viele Bytes gelesen und geschrieben wurden.
Diese Methode eignet sich am besten zum Füllen eines vorab zugewiesenen Array-Puffers. Wenn Sie lediglich ein neues Uint8Array
Objekt aus einem base64-codierten String erstellen möchten, verwenden Sie stattdessen die statische Methode Uint8Array.fromBase64()
.
Syntax
setFromBase64(string)
setFromBase64(string, options)
Parameter
string
-
Ein Base64-String, der Bytes codiert, die in ein
Uint8Array
geschrieben werden sollen. Er hat die gleichen Anforderungen wie derstring
-Parameter vonUint8Array.fromBase64()
. Beachten Sie, dass der String nur bis zu dem Punkt gelesen wird, an dem das Array gefüllt ist, sodass eine ungültige Base64-Syntax danach ignoriert wird. options
Optional-
Ein Objekt, das den Interpretation-Prozess des Base64-Strings anpasst. Es hat die gleichen Anforderungen wie der
options
-Parameter vonUint8Array.fromBase64()
.
Rückgabewert
Ein Objekt mit den folgenden Eigenschaften:
read
-
Die Anzahl der Base64-Zeichen, die aus dem Eingabestring gelesen wurden. Wenn die decodierten Daten in das Array passen, ist dies die Länge des Eingabestrings (einschließlich Padding); andernfalls ist es die Länge bis zum letzten vollständigen 4-Zeichen-Block, der in das Array passt. Blöcke werden niemals geteilt (da die verbleibenden Bits nicht teilweise "zurückgelegt" werden können, ohne das Base64 vollständig neu zu codieren); wenn der nächste Block nicht in den Rest des Arrays passt, wird er vollständig ungelesen, was dazu führt, dass die letzten ein oder zwei Bytes des Arrays nicht geschrieben werden.
written
-
Die Anzahl der Bytes, die in das
Uint8Array
geschrieben wurden. Wird niemals größer als diebyteLength
diesesUint8Array
sein.
Ausnahmen
SyntaxError
-
Wird ausgelöst, wenn der Eingabestring Zeichen außerhalb des angegebenen Alphabets enthält oder wenn der letzte Block die
lastChunkHandling
-Option nicht erfüllt. TypeError
-
Wird in einem der folgenden Fälle ausgelöst:
- Der Eingabestring ist kein String.
- Das
options
-Objekt ist kein Objekt oderundefined
. - Die Optionen haben nicht die erwarteten Werte oder sind
undefined
.
Beispiele
Decodierung eines base64 Strings
Dieses Beispiel verwendet die Standardoptionen alphabet
und lastChunkHandling
, um einen base64-String in ein bestehendes Uint8Array
zu dekodieren.
const uint8Array = new Uint8Array(16);
const result = uint8Array.setFromBase64("PGI+ TURO PC9i Pg==");
console.log(result); // { read: 19, written: 10 }
console.log(uint8Array);
// Uint8Array(16) [60, 98, 62, 77, 68, 78, 60, 47, 98, 62, 0, 0, 0, 0, 0, 0]
Decodierung eines großen Strings in ein kleines Array
Wenn der String mehr Daten enthält, als das Array fassen kann, schreibt die Methode nur so viele Bytes, wie das Array fassen kann, ohne dabei Bits zu verwerfen.
const uint8Array = new Uint8Array(8);
const result = uint8Array.setFromBase64("PGI+ TURO PC9i Pg==");
console.log(result); // { read: 9, written: 6 }
console.log(uint8Array);
// Uint8Array(8) [60, 98, 62, 77, 68, 78, 0, 0]
Beachten Sie, wie die letzten beiden Bytes des Arrays nicht geschrieben werden. Um diese beiden Bytes zu decodieren, müssen wir mindestens drei weitere Base64-Zeichen lesen, die 18 Bits darstellen. Diese passen nicht in die verbleibenden zwei Bytes des Arrays, sodass wir nur 2 Blöcke oder 6 Bytes schreiben können.
Daten an einem bestimmten Versatz setzen
Die setFromBase64()
Methode beginnt immer mit dem Schreiben am Anfang des Uint8Array
. Wenn Sie in die Mitte des Arrays schreiben möchten, können Sie stattdessen in ein TypedArray.prototype.subarray()
schreiben.
const uint8Array = new Uint8Array(16);
// Start writing at offset 2
const result = uint8Array.subarray(2).setFromBase64("PGI+ TURO PC9i Pg==");
console.log(result); // { read: 19, written: 10 }
console.log(uint8Array);
// Uint8Array(16) [0, 0, 60, 98, 62, 77, 68, 78, 60, 47, 98, 62, 0, 0, 0, 0]
Stromdecodierung
Dieses Beispiel ist an den ursprünglichen Vorschlag angelehnt. Es imitiert die API von TextDecoder
mit der stream
-Option. Beachten Sie die Verwendung von lastChunkHandling: "stop-before-partial"
, um unvollständige Blöcke zu bearbeiten.
class Base64Decoder {
#extra = "";
decode(chunk = "", options = {}) {
const opts = { ...options };
// match TextEncoder API
if (opts.stream) {
opts.lastChunkHandling = "stop-before-partial";
}
chunk = this.#extra + chunk;
this.#extra = "";
// For simplicity, allocate new memory every time
// the calculation below is guaranteed to be enough,
// but may be too much if there is whitespace
// if you're really concerned about memory, a TextDecoder style API is a bad choice
let buffer = new Uint8Array(Math.ceil((chunk.length * 3) / 4));
const { read, written } = buffer.setFromBase64(chunk, opts);
buffer = buffer.subarray(0, written);
this.#extra = chunk.slice(read);
return buffer;
}
}
const decoder = new Base64Decoder();
console.log(decoder.decode("SG Vsb ", { stream: true }));
// Uint8Array(3) [72, 101, 108]
console.log(decoder.decode("G8gV29ybGR ", { stream: true }));
// Uint8Array(6) [108, 111, 32, 87, 111, 114]
console.log(decoder.decode(""));
// Uint8Array(2) [108, 100]
Spezifikationen
Specification |
---|
Uint8Array to/from base64 # sec-uint8array.prototype.setfrombase64 |
Browser-Kompatibilität
BCD tables only load in the browser