LinusU / LinusU/node-jsonlines
Adding fileStream information to documentation
Personne n'a encore pris cette issue.
- Langage dominant
- JavaScript
- Étoiles
- 25
- Forks
- 2
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
It might be helpful to include some documentation for people who are unfamiliar with transfer streams (like I was until I asked chatGPT). The docs mention that the stringifier writes to a transfer stream, but this is a subtle, and many people are likely to miss that detail or read through it because they don't know what it means.
Here is the code I wrote that can handle file streams:
import jsonlines from "jsonlines"
import fs from "fs"
import path from 'path'
export default function example () {
// I created a folder in my repo caled "files", and the stringifier will write to it (only locally, don't try this on something like Heroku)
const outputFilePath = path.join('files', 'jsonl-testing.jsonl')
const fileStream = fs.createWriteStream(outputFilePath)
const stringifier = jsonlines.stringify()
stringifier.pipe(fileStream)
stringifier.write({
"prompt": "Question: What is the meaning of life?\n\n###\n\n",
"completion": "Answer: 42.\n\nEND"
})
stringifier.write({
"prompt": "Question: What is not the meaning of life?\n\n###\n\n",
"completion": "Answer: not 42.\n\nEND"
})
stringifier.end()
fileStream.end() // do we need to do this? Docs do not specifiy
}
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Repérez la documentation décrivant le stringifier et les streams de transfert, puis comparez-la avec l’exemple de file-stream dans l’issue. Mettez à jour la documentation afin que les lecteurs comprennent comment effectuer un piping vers fs.createWriteStream et si fileStream.end() est nécessaire ; le travail est terminé lorsque le workflow de file-stream et le comportement de fermeture du stream sont clairs.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript, node.js
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 48/100