npmlog

npmlog

Utilitas logger yang digunakan npm.

Logger ini sangat mendasar. Itu melakukan logging untuk npm. Ini mendukung level khusus dan keluaran berwarna.

Secara default, log ditulis ke stderr. Jika Anda ingin mengirim pesan log ke output selain stream, maka Anda dapat mengubah anggota log.stream , atau Anda dapat mendengarkan peristiwa yang dihasilkannya, dan melakukan apa pun yang Anda inginkan dengannya.

Instalasi

 npm install npmlog --save

Penggunaan Dasar

 var log = require ( 'npmlog' )

// additional stuff ---------------------------+
// message ----------+                         |
// prefix ----+      |                         |
// level -+   |      |                         |
//        v   v      v                         v
    log . info ( 'fyi' , 'I have a kitty cat: %j' , myKittyCat ) 

log.level

• {Rangkaian}

Level untuk menampilkan log. Log apa pun pada atau di atas level ini akan ditampilkan. Tingkat silent khusus akan mencegah apa pun ditampilkan selamanya.

log.catatan

• {Array}

Array dari semua pesan log yang telah dimasukkan.

log.maxRecordSize

• {Nomor}

Jumlah maksimum catatan yang harus disimpan. Jika log.record menjadi lebih besar dari 10% di atas nilai ini, maka log.record akan dipotong menjadi 90% dari nilai ini.

Alasan jendela 10% adalah agar tidak perlu mengubah ukuran array besar di setiap entri log.

log.prefixStyle

• {Obyek}

Objek gaya yang menentukan bagaimana awalan ditata. (Lihat di bawah)

log.headingStyle

• {Obyek}

Objek gaya yang menentukan bagaimana judul diberi gaya. (Lihat di bawah)

log.heading

• {String} Bawaan: ""

Jika disetel, judul yang dicetak di awal setiap baris.

log.stream

• {Stream} Default: process.stderr

Aliran tempat keluaran ditulis.

log.aktifkanWarna()

Paksa warna untuk digunakan pada semua pesan, apa pun aliran keluarannya.

log.disableColor()

Nonaktifkan warna pada semua pesan.

log.aktifkan Kemajuan()

Aktifkan tampilan pemintal aktivitas log dan bilah kemajuan

log.disableProgress()

Nonaktifkan tampilan bilah kemajuan

log.aktifkanUnicode()

Paksa tema unicode untuk digunakan pada bilah kemajuan.

log.disableUnicode()

Nonaktifkan penggunaan unicode di bilah kemajuan.

log.setGaugeTemplate(templat)

Tetapkan templat untuk mengeluarkan bilah kemajuan. Lihat dokumentasi pengukur untuk detailnya.

log.setGaugeThemeset(tema)

Pilih kumpulan tema untuk memilih tema untuk bilah kemajuan. Lihat dokumentasi pengukur untuk detailnya.

log.jeda()

Berhenti mengirimkan pesan ke aliran, tapi jangan membuangnya.

log.resume()

Memancarkan semua pesan dalam buffer yang ditulis saat dijeda.

log.log(level, awalan, pesan, ...)

• level {String} Level untuk memancarkan pesan
• prefix {String} Awalan string. Setel ke "" untuk melewati.
• message... Argumen untuk util.format

Memancarkan pesan log pada tingkat yang ditentukan.

log[level](awalan, pesan, ...)

Misalnya,

• log.konyol(awalan, pesan, ...)
• log.verbose(awalan, pesan, ...)
• log.info(awalan, pesan, ...)
• log.http(awalan, pesan, ...)
• log.warn(awalan, pesan, ...)
• log.error(awalan, pesan, ...)

Seperti log.log(level, prefix, message, ...) . Dengan cara ini, setiap level diberikan singkatan, sehingga Anda dapat melakukan log.info(prefix, message) .

log.addLevel(level, n, gaya, tampilan)

• level {String} Indikator level
• n {Nomor} Tingkat numerik
• style {Object} Objek dengan fg, bg, inverse, dll.
• disp {String} Pengganti opsional untuk level pada output.

Menyiapkan level baru dengan fungsi steno dan sebagainya.

Perhatikan bahwa jika angkanya adalah Infinity , maka menyetel level ke angka tersebut akan menyebabkan semua pesan log disembunyikan. Jika nomornya adalah -Infinity , satu-satunya cara untuk menampilkannya adalah dengan mengaktifkan semua pesan log.

log.newItem(nama, tugas, berat)

• name {String} Opsional; nama item kemajuan.
• todo {Nomor} Opsional; jumlah total pekerjaan yang harus diselesaikan. Bawaan 0.
• weight {Nomor} Opsional; berat barang ini relatif terhadap barang lain. Bawaan 1.

Ini menambahkan pelacak item are-we-there-yet baru ke pelacak kemajuan. Objek yang dikembalikan memiliki metode log[level] namun sebaliknya merupakan objek Tracker are-we-there-yet .

log.newStream(nama, tugas, berat)

Ini menambahkan pelacak aliran baru are-we-there-yet ke pelacak kemajuan. Objek yang dikembalikan memiliki metode log[level] namun sebaliknya merupakan objek TrackerStream are-we-there-yet .

log.newGroup(nama, berat)

Ini menambahkan grup pelacak are-we-there-yet baru ke pelacak kemajuan. Objek yang dikembalikan memiliki metode log[level] namun sebaliknya merupakan objek TrackerGroup are-we-there-yet .

Acara

Semua peristiwa dipancarkan dengan objek pesan.

• log Dipancarkan untuk semua pesan
• log. Dipancarkan untuk semua pesan dengan level .
• Pesan dengan awalan juga memancarkan awalannya sebagai sebuah peristiwa.

Objek Gaya

Objek gaya dapat memiliki bidang berikut:

• fg {String} Warna untuk teks latar depan
• bg {String} Warna untuk latar belakang
• bold , inverse , underline {Boolean} Tetapkan properti terkait
• bell {Boolean} Mengeluarkan suara (Ini mungkin cukup mengganggu.)

Objek Pesan

Setiap peristiwa log dipancarkan dengan objek pesan, dan daftar log.record berisi semua peristiwa yang telah dibuat. Mereka memiliki bidang-bidang berikut:

• id {Nomor}
• level {String}
• prefix {String}
• message {String} Hasil dari util.format()
• messageRaw {Array} Argumen untuk util.format()

Memblokir TTY

Kami menggunakan set-blocking untuk menyetel pemblokiran stderr dan stdout jika keduanya adalah tty dan memiliki panggilan setBlocking. Ini adalah solusi untuk masalah di versi awal Node.js 6.x, yang membuat stderr dan stdout tidak memblokir di OSX. (Mereka selalu memblokir Windows dan tidak pernah memblokir di Linux.) npmlog memerlukannya untuk diblokir sehingga dapat memungkinkan keluaran ke stdout dan stderr saling bertautan.