Skip to content
This repository was archived by the owner on Mar 5, 2025. It is now read-only.

Commit 854424f

Browse files
authored
Merge branch '1.0' into 1.0-csp-fix
2 parents ac41383 + 44a3030 commit 854424f

File tree

105 files changed

+19349
-47420
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+19349
-47420
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,6 @@ bower_components
1212
/bower
1313
.idea/
1414
.npm/
15-
.vscode/
15+
.vscode/
16+
dist/
17+
!./dist/web3.min.js

ISSUE_TEMPLATE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!---
2+
3+
Steps before creating an issue:
4+
5+
1. I've read the documentation.
6+
2. I was looking for an solution on stackoverflow or something else.
7+
3. I was looking for an identical issue.
8+
9+
-->
10+
11+
#### Expected behavior
12+
13+
#### Actual behavior
14+
15+
#### Steps to reproduce the behavior
16+
17+
1. [First step]
18+
2. [Second step]
19+
3. [and so on...]
20+
21+
#### Logs
22+
23+
#### Versions
24+
[NPM, Node, Web3.js, OS, device...]

PULL_REQUEST_TEMPLATE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Description
2+
3+
Please include a summary of the change.
4+
5+
<!---
6+
Optional if an issue is fixed:
7+
Fixes #(issue)
8+
-->
9+
10+
## Type of change
11+
12+
<!--- Please delete options that are not relevant. -->
13+
14+
- [ ] Bug fix (non-breaking change which fixes an issue)
15+
- [ ] New feature (non-breaking change which adds functionality)
16+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
17+
18+
## Checklist:
19+
20+
- [ ] I have selected the correct base branch.
21+
- [ ] I have performed a self-review of my own code.
22+
- [ ] I have commented my code, particularly in hard-to-understand areas.
23+
- [ ] I have made corresponding changes to the documentation.
24+
- [ ] My changes generate no new warnings.
25+
- [ ] Any dependent changes have been merged and published in downstream modules.
26+
- [ ] I ran ```npm run test``` with success and extended the tests if necessary.
27+
- [ ] I ran ```npm run build``` and tested the resulting file from ```dist``` folder in a browser.
28+
- [ ] I have tested my code on the live network.

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,25 @@ web3.eth.getAccounts()
8181
.then(console.log);
8282
```
8383

84+
### Usage with TypeScript
85+
86+
Type definitions are maintained at [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) by others. You can install them with
87+
88+
```bash
89+
npm install --dev @types/web3.js
90+
```
91+
92+
You might need to install type definitions for `bignumber.js` and `lodash` too.
93+
94+
And then use `web3.js` as follows:
95+
96+
```typescript
97+
import Web3 = require("web3"); // Note the special syntax! Copy this line when in doubt!
98+
const web3 = new Web3("ws://localhost:8546");
99+
```
100+
101+
**Please note:** We do not support TypeScript ourselves. If you have any issue with TypeScript and `web3.js` do not create an issue here. Go over to DefinitelyTyped and do it there.
102+
84103
## Documentation
85104

86105
Documentation can be found at [read the docs][docs]

bower.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"namespace": "ethereum",
33
"name": "web3",
4-
"version": "1.0.0-beta.34",
4+
"version": "1.0.0-beta.35",
55
"description": "Ethereum JavaScript API",
66
"license": "LGPL-3.0",
77
"main": [

0 commit comments

Comments
 (0)