Skip to content

Commit c9a0e57

Browse files
author
Alan Shaw
authored
docs: add kebab case breaking change (ipfs#1138)
resolves ipfs#1137
1 parent 7007e5a commit c9a0e57

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

CHANGELOG.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,15 @@
5151

5252
### BREAKING CHANGES
5353

54-
* ```javascript
55-
Promise<{oldCfg, newCfg}> ipfs.config.profile(name, opts)
54+
* Configuration profiles API has changed:
55+
```javascript
56+
Promise<{oldCfg, newCfg}> ipfs.config.profile(name, opts)
5657

57-
// is now
58-
Promise<{old, new}> ipfs.config.profiles.apply(name, opts)
59-
```
60-
61-
Possibly contentious;
58+
// is now
59+
Promise<{old, new}> ipfs.config.profiles.apply(name, opts)
60+
```
6261

63-
Adds `callbackify` as a dependency, see https://github.com/ipfs/js-ipfs/issues/2506
62+
* Possibly contentious; Adds `callbackify` as a dependency, see https://github.com/ipfs/js-ipfs/issues/2506
6463
for discussion.
6564

6665

@@ -138,7 +137,9 @@ for discussion.
138137
<a name="35.0.0"></a>
139138
# [35.0.0](https://github.com/ipfs/js-ipfs-http-client/compare/v34.0.0...v35.0.0) (2019-09-04)
140139

140+
### BREAKING CHANGES
141141

142+
Kebab case options (e.g. `wrap-with-directory`) are no longer supported in `ipfs.add`. Use camel case instead (e.g. `wrapWithDirectory`).
142143

143144
<a name="34.0.0"></a>
144145
# [34.0.0](https://github.com/ipfs/js-ipfs-http-client/compare/v33.1.1...v34.0.0) (2019-08-29)

0 commit comments

Comments
 (0)