الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل

أورا

الدوار الطرفي الأنيق

ثَبَّتَ

 NPM تثبيت ORA

تحقق من yocto-spinner للحصول على بديل أصغر.

الاستخدام

 استيراد ora من 'ora' ؛ const spinner = ora ('loading unicorns'). start () ؛ setTimeOut (() => {spinner.color = 'yellow' ؛ spinner.text = 'loading rainbows' ؛} ، 1000) ؛

API

أورا (نص)

أورا (خيارات)

إذا تم توفير سلسلة ، يتم التعامل معها كاختصار options.text . النص.

خيارات

النوع: object

نص

اكتب: string

النص لعرضه بجوار الدوار.

بادئة

النوع: string | () => string

نص أو وظيفة تُرجع النص لعرضها قبل الدوار. لن يتم عرض أي نص بادئة إذا تم تعيينه على سلسلة فارغة.

لاحقة

النوع: string | () => string

نص أو وظيفة تُرجع النص لعرضها بعد نص الدوار. لن يتم عرض نص لاحقة إذا تم ضبطه على سلسلة فارغة.

الدوار

النوع: string | object
الافتراضي: 'dots'

اسم واحد من المغازل المقدمة. انظر example.js في هذا الريبو إذا كنت ترغب في اختبار المغازل المختلفة. على Windows (باستثناء Terminal Windows) ، سيستخدم دائمًا line الدوار حيث لا يحتوي سطر أوامر Windows على دعم Unicode المناسب.

أو كائن مثل:

 {إطارات: ['-' ، '+' ، '-'] ، الفاصل الزمني: 80 // اختياري}
لون

اكتب: string
الافتراضي: 'cyan'
القيم: 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray'

لون الدوار.

Hidecursor

النوع: boolean
الافتراضي: true

اضبط على false لمنع ORA من إخفاء المؤشر.

البادئة

النوع: number
الافتراضي: 0

المسافة البادئة الدوار مع العدد المعطى من المساحات.

فاصلة

النوع: number
الافتراضي: المقدمة من الدوار أو 100

الفاصل بين كل إطار.

يوفر المغازل الفاصل الزمني الموصى به ، لذلك لا تحتاج حقًا إلى تحديد ذلك.

تدفق

النوع: stream.Writable
الافتراضي: process.stderr

دفق لكتابة الإخراج.

يمكنك على سبيل المثال تعيين هذا على process.stdout بدلاً من ذلك.

isenabled

النوع: boolean

القوة تمكين/تعطيل الدوار. إذا لم يتم تحديدها ، فسيتم تمكين الدوار إذا تم تشغيل stream داخل سياق tty (لم يولد أو أنابيب) و/أو لا في بيئة CI.

لاحظ أن {isEnabled: false} لا يعني أنه لن يخرج أي شيء. هذا يعني فقط أنه لن يخرج الدوار والألوان ورموز الهروب من ANSI. سيظل يسجل النص.

Issilent

النوع: boolean
الافتراضي: false

تعطيل الدوار وجميع نص السجل. يتم قمع جميع الإخراج وسيعتبر isEnabled false .

discardstdin

النوع: boolean
الافتراضي: true

تجاهل إدخال stdin (باستثناء Ctrl+C) أثناء التشغيل إذا كان tty. هذا يمنع الدوار من الوخز عند الإدخال ، وإخراج الخطوط المكسورة عند إدخال مكابس المفتاح ، ويمنع التخزين المؤقت للإدخال أثناء تشغيل الدوار.

هذا ليس له أي تأثير على Windows لأنه لا توجد طريقة جيدة لتنفيذ التخلص من stdin بشكل صحيح هناك.

مثال

.Text GET/SET

تغيير النص المعروض بعد الدوار.

.prefixtext get/set

تغيير النص قبل الدوار.

لن يتم عرض أي نص بادئة إذا تم تعيينه على سلسلة فارغة.

.SuffixText GET/SET

تغيير النص بعد نص الدوار.

لن يتم عرض نص لاحقة إذا تم ضبطه على سلسلة فارغة.

.color get/set

تغيير لون الدوار.

.spinner get/set

تغيير الدوار.

.indent الحصول على/مجموعة

تغيير المسافة البادئة الدوار.

.isspinning الحصول

منطقية تشير إلى ما إذا كان المثيل يدور حاليًا.

الحصول على

الفاصل بين كل إطار.

يتم تحديد الفاصل الزمني من قبل الدوار المختار.

.start (نص؟)

بدء الدوار. إرجاع المثيل. اضبط النص الحالي إذا تم توفير text .

.قف()

توقف ومسح الدوار. إرجاع المثيل.

.scede (النص؟)

أوقف الدوار ، وقم بتغييره إلى اللون ✔ واستمر في النص الحالي ، أو text إذا تم توفيره. إرجاع المثيل. انظر GIF أدناه.

.fail (نص؟)

أوقف الدوار ، وقم بتغييره إلى اللون الأحمر ✖ واستمر في النص الحالي ، أو text إذا تم توفيره. إرجاع المثيل. انظر GIF أدناه.

.war (نص؟)

أوقف الدوار ، وقم بتغييره إلى أصفر واستمر في النص الحالي ، أو text إذا تم توفيره. إرجاع المثيل.

.info (نص؟)

أوقف الدوار ، وقم بتغييره إلى اللون ℹ واستمر في النص الحالي ، أو text إذا تم توفيره. إرجاع المثيل.

.stopandpersist (خيارات؟)

أوقف الدوار وقم بتغيير الرمز أو النص. إرجاع المثيل. انظر GIF أدناه.

خيارات

النوع: object

رمز

اكتب: string
تقصير: ' '

رمز لاستبدال الدوار مع.

نص

اكتب: string
الافتراضي: 'text' الحالي

نص ليتم استمراره بعد الرمز.

بادئة

النوع: string | () => string
الافتراضي: prefixText الحالية

نص أو وظيفة تُرجع النص ليتم استمراره قبل الرمز. لن يتم عرض أي نص بادئة إذا تم تعيينه على سلسلة فارغة.

لاحقة

النوع: string | () => string
الافتراضي: suffixText الحالية

نص أو وظيفة تُرجع النص ليتم استمراره بعد النص بعد الرمز. لن يتم عرض نص لاحقة إذا تم ضبطه على سلسلة فارغة.

.واضح()

مسح الدوار. إرجاع المثيل.

.يجعل()

تقديم إطار جديد يدويًا. إرجاع المثيل.

.إطار()

احصل على إطار جديد.

orapromise (عمل ، نص)

orapromise (العمل ، الخيارات)

يبدأ الدوار للحصول على وعد أو وظيفة إعادة الوعد. يتم إيقاف الدوار مع .succeed() إذا كان الوعد يفي أو مع .fail() إذا كان يرفض. يعيد الوعد.

 استيراد {orapromise} من 'ora' ؛ في انتظار orapromise (somepromise) ؛

فعل

النوع: Promise | ((spinner: ora.Ora) => Promise)

خيارات

النوع: object

جميع الخيارات بالإضافة إلى ما يلي:

النجاح

النوع: string | ((result: T) => string) | undefined

النص الجديد للدوران عند حل الوعد.

يحافظ على النص الحالي إذا undefined .

FailText

النوع: string | ((error: Error) => string) | undefined

النص الجديد للدوران عند رفض الوعد.

يحافظ على النص الحالي إذا undefined .

المغازل

النوع: Record<string, Spinner>

كل ما قدمت المغازل.

التعليمات

كيف يمكنني تغيير لون النص؟

استخدم chalk أو yoctocolors :

 استيراد ORA من 'ora' ؛ استيراد الطباشير من 'Chalk' ؛ const spinner = ora (`تحميل $ {chalk.red ('Unicorns')}`) .start () ؛

لماذا يتجمد الدوار؟

JavaScript أحادية الخيوط ، لذلك ستعمل أي عمليات متزامنة على منع الرسوم المتحركة للدوران. لتجنب ذلك ، تفضل استخدام العمليات غير المتزامنة.

متعلق ب

  • Yocto -Spinner - Spininal Tiny Terminal

  • cli -spinners - المغازل للاستخدام في المحطة

الموانئ

  • Clispinner - مكتبة Spinner Terminal لـ Swift

  • هالو - ميناء بيثون

  • المغازل - المغازل الطرفية للصدأ

  • MARQUEE -ORA - SCROLLING MARQUEE SPINNER لأورا

  • Briandowns/Spinner - مؤشر الدوار/التقدم الطرفي للذهاب

  • TJ/Go -Spin - حزمة الدوار الطرفية لـ GO

  • ObscelableHQ.com/@victordidenko/ora - منفذ ORA إلى دفاتر ملاحظات يمكن ملاحظتها

  • كيا - المغازل الطرفية البسيطة لدنو؟

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل