الوحدة String Decoder في Node.js

من موسوعة حسوب

وحدة فك الترميز string_decoder توفر واجهة برمجية API لفك ترميز كائنات Buffer إلى سلاسل بطريقة تصون المحارف متعددة البايتات المرمزة بواسطة UTF-8 و UTF-16. يمكن الوصول إلى هذه الوحدة باستخدام:

const { StringDecoder } = require('string_decoder');

المثال التالي يعرض الاستخدام الأساسي لصنف StringDecoder:

const { StringDecoder } = require('string_decoder');
const decoder = new StringDecoder('utf8');

const cent = Buffer.from([0xC2, 0xA2]);
console.log(decoder.write(cent));

const euro = Buffer.from([0xE2, 0x82, 0xAC]);
console.log(decoder.write(euro));

عندما تُكتَب نسخة من الصنف Buffer إلى نسخة من الصنف StringDecoder، ستُستخدم ذاكرة مؤقتة داخلية لضمان أنّ السلسلة مفكوكة الترميز لا تحوي أي محارف متعددة البايت غير مكتملة.حيث تُحفظ في الذاكرة المؤقتة حتى الإستدعاء التالي للتابع stringDecoder.write()‎ أو حتى يستدعى التابع stringDecoder.end()‎. في المثال التالي، البايتات الثلاث مرمّزة بترميز UTF-8  لرمز اليورو الأوروبي ()، تُكتب عبر ثلاث عمليات منفصلة:

const { StringDecoder } = require('string_decoder');
const decoder = new StringDecoder('utf8');

decoder.write(Buffer.from([0xE2]));
decoder.write(Buffer.from([0x82]));
console.log(decoder.end(Buffer.from([0xAC])));

الصنف StringDecoder

new StringDecoder([encoding])‎

أُضيف في الإصدار: 0.1.99

  • encoding<string‎>‎: ترميز المحارف الذي سيستخدمه الصنف StringDecoder. القيمة الافتراضية: 'utf8' ينشئ نسخة جديدة من الصنف StringDecoder.

stringDecoder.end([buffer])‎

أُضيف في الإصدار: 0.9.3

  • buffer <Buffer>‎: نسخة من الصنف Buffer لكي يُفك ترميزها
  • القيمة المعادة: سلسلة نصية <string>.

يعيد أي مدخلات متبقية محفوظة في الذاكرة المؤقتة الداخلية كسلسلة نصية،  ستُبدّل محارف ال UTF-8 و UTF-16 غير المكتملة إلى بديل مناسب لترميز المحارف المستخدم.

إذا كان الوسيط buffer متوافرًا، سوف يُنجز استدعاء أخير واحد للتابع stringDecoder.write()‎ قبل إعادة باقي الدخل.

stringDecoder.write(buffer)‎

سجل التغييرات

الإصدار التغييرات
v8.0.0 كل محرف غير متوفر يستبدل الآن بمحرف بديل فريد عوضًا عن واحد لكل بايت منفرد.
v0.1.99 أضيف في: v0.1.99
  • buffer <Buffer>‎: نسخة من الصنف Buffer لكي يُفك ترميزها.
  • القيمة المُعادة: سلسلة نصية <string>.

تعاد سلسة نصية مفكوكة الترميز، ضامنة أنّ أي محارف غير مكتملة في نهاية المعامل Buffer سوف تُهمل في السلسلة المعادة وتخزن في ذاكرة مؤقتة داخلية للاستدعاء القادم للتابع stringDecoder.write()‎ أو stringDecoder.end()‎.

مصادر