Skip to content

Commit

Permalink
feat(ts): updates package to use TS
Browse files Browse the repository at this point in the history
Implements types for custom data structures and config objects. Converts
enum objects to TS enums. Updates tests and jest to use TS config. Adds
eslint.
  • Loading branch information
jshor committed Mar 31, 2021
1 parent ccca653 commit 2c4740a
Show file tree
Hide file tree
Showing 136 changed files with 2,257 additions and 1,261 deletions.
25 changes: 25 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
module.exports = {
root: true,
parser: '@typescript-eslint/parser',
plugins: [
'@typescript-eslint'
],
rules: {
'semi': ['error', 'never'],
'comma-dangle': ['error', 'never'],
'no-prototype-builtins': 'off',
'@typescript-eslint/no-explicit-any': 'off'
},
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended'
],
overrides: [
{
files: [
'src/*.ts',
'test/e2e/*.ts'
]
}
]
}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
node_modules
coverage
build
dist
.zint
bin
.nyc_output
Expand Down
1 change: 1 addition & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
test
docs
build
bin
.zint
.github
1 change: 1 addition & 0 deletions .yarnrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
network-timeout 100000
46 changes: 25 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,24 @@ yarn add symbology

### Code 11 Example

```js
const symbology = require('symbology')
```ts
import { SymbologyType, createFile } from 'symbology'

symbology
.createStream({
(async () => {
const { data } = await createStream({
symbology: symbology.Barcode.CODE128
}, '8765432164')
.then((data) => {
console.log('Result: ', data)
})

console.log('Result: ', data)
})()
```

This will log:

```json
{
"data": "data:image/png+data;base64,PHN [...] eFd==",
"message": "",
"message": "Symbology successfully created.",
"code": 0
}
```
Expand All @@ -69,17 +69,19 @@ And the base64 PNG generated will look like:

### MaxiCode Example

```js
symbology
.createFile({
symbology: Symbology.Barcode.MAXICODE,
```ts
import { SymbologyType, createFile } from 'symbology'

(async () => {
const { data } = await createFile({
symbology: SymbologyType.MAXICODE,
option1: 2,
primary: '999999999840012',
fileName: 'maxiCodeExample.svg'
}, 'Secondary Message Here')
.then((data) => {
console.log('Result: ', data)
})

console.log('Result: ', data)
})()
```

This creates `maxiCodeExample.svg` which looks like:
Expand All @@ -88,15 +90,17 @@ This creates `maxiCodeExample.svg` which looks like:

### USPS Example

```js
symbology
.createFile({
```ts
import { SymbologyType, createFile } from 'symbology'

(async () => {
const { data } = await createFile({
symbology: Symbology.Barcode.ONECODE
fileName: 'uspsExample.eps'
}, '01234567094987654321-01234')
.then((data) => {
console.log('Result: ', data)
})

console.log('Result: ', data)
})()
```

This creates `uspsExample.eps` which looks like:
Expand Down
2 changes: 1 addition & 1 deletion docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ module.exports = {
host: 'localhost',
serviceWorker: true,
themeConfig: {
logo: '/assets/symbology-logo.svg',
logo: '/assets/hero.svg',
repo: 'jshor/symbology',
docsDir: 'docs',
editLinks: true,
Expand Down
4 changes: 2 additions & 2 deletions docs/.vuepress/public/assets/hero.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 0 additions & 35 deletions docs/.vuepress/public/assets/symbology-logo.svg

This file was deleted.

3 changes: 0 additions & 3 deletions docs/.vuepress/styles/index.styl

This file was deleted.

25 changes: 16 additions & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,25 @@ yarn add symbology

### Example usage

```js
const symbology = require('symbology')

(async function () {
```ts
import {
SymbologyType,
OutputTypes,
EncodingMode,
createStream
} from 'symbology'

(async () => {
try {
const data = await symbology.createStream({
symbology: symbology.Barcode.CODE128,
backgroundColor: 'ff00ff',
foregroundColor: '00ff00'
const { data } = await createFile({
symbology: SymbologyType.CODE128,
encoding: EncodingMode.GS1_MODE,
fileName: 'out.svg',
backgroundColor: '00000000',
foregroundColor: '00ff00ff'
}, '12345')

console.log('Result: ', data)
console.log('File successfully created.')
} catch (err) {
console.error('Error: ', err)
}
Expand Down
18 changes: 10 additions & 8 deletions docs/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,20 @@ yarn add symbology

### Example usage

```js
const symbology = require('symbology')
```ts
import { SymbologyType, OutputTypes, EncodingMode, createStream } from 'symbology'

(async function () {
(async () => {
try {
const data = await symbology.createStream({
symbology: symbology.Barcode.CODE128,
backgroundColor: 'ff00ff',
foregroundColor: '00ff00'
const { data } = await createFile({
symbology: SymbologyType.CODE128,
encoding: EncodingMode.GS1_MODE,
fileName: 'out.svg',
backgroundColor: '00000000',
foregroundColor: '00ff00ff'
}, '12345')

console.log('Result: ', data)
console.log('File successfully created.')
} catch (err) {
console.error('Error: ', err)
}
Expand Down

0 comments on commit 2c4740a

Please sign in to comment.