@mercury-labs/nest-hashing
v2.0.2
Published
Mercury framework hashing library
Downloads
50
Maintainers
Readme
Mercury Hashing
A simple NestJS module package for encoding/decoding string.
Install
npm install --save @mercury-labs/nest-hashing
Register
HashingModule.forRoot({
secretKey: 'GOo7cVgnCBnR8TvXIgvamXNb85cPVtJi',
global: false,
enabled: true,
})
Register async
HashingModule.forRootAsync({
useFactory: (config: ConfigService) => {
return {
secretKey: config.get('HASHING_SECRET_KEY') || '',
enabled: true,
}
},
inject: [ConfigService],
global: false
})
Notes:
- The
secretKey
should be 32 characters string.
Sample usages
import { HashTextService } from '@mercury-labs/nest-hashing'
import { Injectable } from '@nestjs/common'
@Injectable()
export class TestService {
public constructor(private readonly _hashTextService: HashTextService) {
}
public sample() {
const hashed = this._hashTextService.encode('John Doe')
const decoded = this._hashTextService.decode(hashed)
const hashedObj = this._hashTextService.encodeJSON({
name: 'John Doe',
gender: 'male',
})
const decodedObj = this._hashTextService.decodeJSON<{
name: string,
gender: string
}>(hashedObj)
return {
hashed,
decoded
}
}
}