Skip to content

Commit 9e73060

Browse files
author
Pelle Wessman
committed
Breaking: Use a named export
Increases compatibility a lot across CommonJS / ESM / TypeScript Also makes it easier to export other things in the future
1 parent 4fe7055 commit 9e73060

File tree

5 files changed

+25
-3
lines changed

5 files changed

+25
-3
lines changed

.eslintignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
/dist
2+
/index.d.ts
3+
/index.js
24
/src

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,25 @@ SDK for the Socket API client, generated by `api`.
1313
npm install @socketsecurity/sdk
1414
```
1515

16+
### ESM / TypeScript
17+
1618
```javascript
17-
const client = require('@socketsecurity/sdk').auth('yourApiKeyHere')
19+
import { socketSdk } from '@socketsecurity/sdk'
20+
21+
const client = socketSdk.auth('yourApiKeyHere')
1822

1923
const res = await client.getIssuesByNPMPackage({
2024
package: '@socketsecurity/eslint-config',
2125
version: '1.0.0'
2226
})
2327
```
2428

29+
### CommonJS
30+
31+
```javascript
32+
const { socketSdk } = require('@socketsecurity/sdk')
33+
```
34+
2535
## See also
2636

2737
* [Socket API Reference](https://docs.socket.dev/reference)

index.d.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import socketSdk from './dist'
2+
3+
export { socketSdk }

index.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
'use strict';
2+
3+
const socketSdk = require('./dist').default;
4+
5+
module.exports = { socketSdk }

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@
1616
"main": "./dist/index.js",
1717
"types": "./dist/index.d.ts",
1818
"files": [
19-
"dist/**/*.js",
2019
"dist/**/*.d.ts",
21-
"dist/**/*.json"
20+
"dist/**/*.js",
21+
"dist/**/*.json",
22+
"index.d.ts",
23+
"index.js"
2224
],
2325
"dependencies": {
2426
"api": "^5.0.0-beta.3",

0 commit comments

Comments
 (0)