Skip to content

BREAKING: move constants out of main export #71

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

Closed
wants to merge 1 commit into from
Closed

BREAKING: move constants out of main export #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ const prefixedProtobuf = multicodec.addPrefix('protobuf', protobufBuffer)
// prefixedProtobuf 0x50...

// The multicodec codec values can be accessed directly:
console.log(multicodec.DAG_CBOR)
console.log(multicodec.codecs.DAG_CBOR)
// 113

// To get the string representation of a codec, e.g. for error messages:
Expand Down
4 changes: 2 additions & 2 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ function getVarint (code) {
}

// Make the constants top-level constants
const constants = require('./constants')
const codecs = require('./constants')

// Human friendly names for printing, e.g. in error messages
const print = require('./print')
Expand All @@ -142,5 +142,5 @@ module.exports = {
getCodeVarint,
getVarint,
print,
...constants
codecs
}
18 changes: 9 additions & 9 deletions test/multicodec.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ describe('multicodec', () => {
const buf = uint8ArrayFromString('hey')
const prefixedBuf = multicodec.addPrefix('dag-cbor', buf)
const code = multicodec.getCode(prefixedBuf)
expect(code).to.eql(multicodec.DAG_CBOR)
expect(code).to.eql(multicodec.codecs.DAG_CBOR)
})

it('returns varint from code', () => {
const code = multicodec.getVarint(multicodec.KECCAK_256)
const code = multicodec.getVarint(multicodec.codecs.KECCAK_256)
expect(code).to.eql([0x1b])
})

Expand All @@ -67,9 +67,9 @@ describe('multicodec', () => {
})

it('returns the codec number from constant', () => {
expect(multicodec.ETH_BLOCK).to.eql(144)
expect(multicodec.DAG_PB).to.eql(112)
expect(multicodec.BLAKE2B_8).to.eql(0xb201)
expect(multicodec.codecs.ETH_BLOCK).to.eql(144)
expect(multicodec.codecs.DAG_PB).to.eql(112)
expect(multicodec.codecs.BLAKE2B_8).to.eql(0xb201)
})

it('returns the name from codec number', () => {
Expand All @@ -78,10 +78,10 @@ describe('multicodec', () => {
expect(multicodec.print[0x0111]).to.eql('udp')
expect(multicodec.print[0xb201]).to.eql('blake2b-8')

expect(multicodec.print[multicodec.ETH_BLOCK]).to.eql('eth-block')
expect(multicodec.print[multicodec.DAG_PB]).to.eql('dag-pb')
expect(multicodec.print[multicodec.UDP]).to.eql('udp')
expect(multicodec.print[multicodec.BLAKE2B_8]).to.eql('blake2b-8')
expect(multicodec.print[multicodec.codecs.ETH_BLOCK]).to.eql('eth-block')
expect(multicodec.print[multicodec.codecs.DAG_PB]).to.eql('dag-pb')
expect(multicodec.print[multicodec.codecs.UDP]).to.eql('udp')
expect(multicodec.print[multicodec.codecs.BLAKE2B_8]).to.eql('blake2b-8')
})

it('returns p2p when 0x01a5 is used', () => {
Expand Down