winstonjs/winston

Document Http transfer

Open

#1118 opened on Oct 30, 2017

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (21,967 stars) (1,789 forks)batch import
DocsHelp Wanted

Description

Hello! There is no documentation about the Http transfer module, other than, that it exists. It would be great to see examples.

Contributor guide

Tech stack
javascriptnodejs
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Start by examining the winston source code, specifically the Http transport in lib/winston/transports/http.js. Understand the constructor options (host, port, path, etc.) and how to instantiate the transport. Then, create a documentation section with examples. Review any existing test files for usage patterns. Since the issue is old, ensure the documentation matches the current version of the code.