@mercury-labs/hashing/README.MD

Mercury framework hashing library

# Mercury Hashing
#### A simple NestJS module package for encoding/decoding string.

## Install
```shell
npm install --save @mercury-labs/hashing
```

## Register
```typescript
HashingModule.forRoot({
  secretKey: 'GOo7cVgnCBnR8TvXIgvamXNb85cPVtJi',
  global: false
})
```

## Register async
```typescript
HashingModule.forRootAsync({
  useFactory: (config: ConfigService) => {
    return {
      secretKey: config.get('HASHING_SECRET_KEY') || '',
    }
  },
  inject: [ConfigService],
  global: false
})
```

#### Notes:
- The `secretKey` should be 32 characters string.

## Sample usages

```typescript
import { HashTextService } from '@mercury-labs/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
    }
  }
}
```