Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improving of the providers documentation #3117

Closed
12 tasks
nivida opened this issue Oct 8, 2019 · 1 comment
Closed
12 tasks

Improving of the providers documentation #3117

nivida opened this issue Oct 8, 2019 · 1 comment
Labels
1.x 1.0 related issues Documentation Relates to project wiki or documentation

Comments

@nivida
Copy link
Contributor

nivida commented Oct 8, 2019 •
edited
Loading

Description

Documenting the existing web3.js providers with their interfaces and options.

  • HttpProvider
    • Configuration
    • Interface
    • Special behaviours
  • WebsocketProvider
    • Configuration
    • Interface
    • Special behaviours
  • IpcProvider
    • Configuration
    • Interface
    • Special behaviours

Versions

  • web3.js: 1.x
@nivida nivida added Documentation Relates to project wiki or documentation 1.x 1.0 related issues labels Oct 8, 2019
@nivida nivida mentioned this issue Oct 8, 2019
Merged
@web3 web3 deleted a comment from leagithub Jan 7, 2020
@nivida nivida mentioned this issue Jan 7, 2020
Merged
@cgewecke
Copy link
Collaborator

cgewecke commented Jun 9, 2020

We've added a config section to the docs here and the module README look complete as well.

IPC is still under-documented but it receives very little use. Closing for now.

@cgewecke cgewecke closed this as completed Jun 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
1.x 1.0 related issues Documentation Relates to project wiki or documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nivida @cgewecke