Skip to content

Commit b3580a6

Browse files
committed
fix: deprecate buffer property for now
1 parent 0961a84 commit b3580a6

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

src/cid.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,6 @@ export default multiformats => {
195195
const [version, code, multihash] = decodeCID(bytes)
196196
Object.defineProperties(this, {
197197
// ArrayBufferView
198-
buffer: property(bytes.buffer, { enumerable: false }),
199198
byteOffset: property(bytes.byteOffset, { enumerable: false }),
200199
byteLength: property(bytes.byteLength, { enumerable: false }),
201200

@@ -217,6 +216,10 @@ export default multiformats => {
217216
throw new Error('"codec" property is deprecated, use integer "code" property instead')
218217
}
219218

219+
get buffer () {
220+
throw new Error('Deprecated .buffer property, use .bytes to get Uint8Array instead')
221+
}
222+
220223
get multibaseName () {
221224
throw new Error('"multibaseName" property is deprecated')
222225
}

test/test-cid.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -444,4 +444,9 @@ describe('CID', () => {
444444
const encoded = varint.encode(2)
445445
await testThrow(() => CID.from(encoded), 'Invalid CID version 2')
446446
})
447+
test('buffer', async () => {
448+
const hash = await multihash.hash(Buffer.from('abc'), 'sha2-256')
449+
const cid = CID.create(1, 112, hash)
450+
await testThrow(() => cid.buffer, 'Deprecated .buffer property, use .bytes to get Uint8Array instead')
451+
})
447452
})

0 commit comments

Comments
 (0)