sendscript 0.1.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -4,8 +4,20 @@ All notable changes to this project will be documented in this file. Dates are d
4
4
 
5
5
  Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
6
6
 
7
+ #### [v0.1.3](https://github.com/bas080/sendscript/compare/v0.1.2...v0.1.3)
8
+
9
+ - Remove the d.ts file gen step [`801b2cf`](https://github.com/bas080/sendscript/commit/801b2cf3b38259455186d4df85d98a42c046287c)
10
+
11
+ #### [v0.1.2](https://github.com/bas080/sendscript/compare/v0.1.1...v0.1.2)
12
+
13
+ > 4 January 2024
14
+
15
+ - Update tap to 10.9.5 [`4e3ddcc`](https://github.com/bas080/sendscript/commit/4e3ddcca823ca64c52bc1966ac23a712480d6c4d)
16
+
7
17
  #### [v0.1.1](https://github.com/bas080/sendscript/compare/v0.1.0...v0.1.1)
8
18
 
19
+ > 4 January 2024
20
+
9
21
  - Add a json schema for the sendscript program [`2acf884`](https://github.com/bas080/sendscript/commit/2acf8848134e1ae175afc0af9c5f1e93c4039f8f)
10
22
  - Document a way of using sendscript with typescript [`2683c28`](https://github.com/bas080/sendscript/commit/2683c2873b8c4833711cdb00c777792c0630954a)
11
23
  - Improve naming of promise helper [`e177f39`](https://github.com/bas080/sendscript/commit/e177f39c740bc16864f1ed4fc90a6daa3321751f)
package/README.md CHANGED
@@ -21,6 +21,7 @@ Write JS code that you can run on servers, browsers or other clients.
21
21
  - [Formatting](#formatting)
22
22
  - [Changelog](#changelog)
23
23
  - [Dependencies](#dependencies)
24
+ - [License](#license)
24
25
 
25
26
  <!-- tocstop -->
26
27
 
@@ -192,21 +193,18 @@ There is a good use-case to write an environment module in TypeScript.
192
193
  coding.
193
194
  2. You can use tools like [typedoc][typedoc] to generate docs from your types to
194
195
  share with consumers of your API.
195
- 3. You can generate a .d.ts with `tsc --declaration` and use it to coerce your
196
- client to adopt the modules type.
196
+ 3. You can use the types of the module to coerce your client to adopt the
197
+ modules type.
197
198
 
198
199
  ```bash
199
200
  # Create pretty docs for your module.
200
201
  npx typedoc my-module.ts
201
-
202
- # Create the .d.ts file for your module.
203
- tsc --declaration
204
202
  ```
205
203
 
206
- Now we can use the `my-module.d.ts` file for the client API.
204
+ Now we can use the `my-module.ts` file for the client API.
207
205
 
208
206
  ```ts
209
- import type * as MyModule from './my-module.d.ts'
207
+ import type * as MyModule from './my-module'
210
208
 
211
209
  import sendScriptApi from 'sendscript/api.mjs'
212
210
 
@@ -232,11 +230,11 @@ npm t -- report text-summary
232
230
  ```
233
231
  ```
234
232
 
235
- > sendscript@0.1.1 test
233
+ > sendscript@0.1.3 test
236
234
  > tap -R silent
237
235
 
238
236
 
239
- > sendscript@0.1.1 test
237
+ > sendscript@0.1.3 test
240
238
  > tap report text-summary
241
239
 
242
240
 
@@ -273,6 +271,15 @@ Check if packages are up to date on release.
273
271
  npm outdated && echo 'No outdated packages found'
274
272
  ```
275
273
  ```
276
- Package Current Wanted Latest Location Depended by
277
- tap 18.5.2 18.6.1 18.6.1 node_modules/tap sendscript
274
+ No outdated packages found
278
275
  ```
276
+
277
+ ## License
278
+
279
+ See the [LICENSE.txt][license] file for details.
280
+
281
+ [license]:./LICENSE.txt
282
+ [socket.io]:https://socket.io/
283
+ [changelog]:./CHANGELOG.md
284
+ [auto-changelog]:https://www.npmjs.com/package/auto-changelog
285
+ [typedoc]:https://github.com/TypeStrong/typedoc
package/README.mz CHANGED
@@ -174,21 +174,18 @@ There is a good use-case to write an environment module in TypeScript.
174
174
  coding.
175
175
  2. You can use tools like [typedoc][typedoc] to generate docs from your types to
176
176
  share with consumers of your API.
177
- 3. You can generate a .d.ts with `tsc --declaration` and use it to coerce your
178
- client to adopt the modules type.
177
+ 3. You can use the types of the module to coerce your client to adopt the
178
+ modules type.
179
179
 
180
180
  ```bash
181
181
  # Create pretty docs for your module.
182
182
  npx typedoc my-module.ts
183
-
184
- # Create the .d.ts file for your module.
185
- tsc --declaration
186
183
  ```
187
184
 
188
- Now we can use the `my-module.d.ts` file for the client API.
185
+ Now we can use the `my-module.ts` file for the client API.
189
186
 
190
187
  ```ts
191
- import type * as MyModule from './my-module.d.ts'
188
+ import type * as MyModule from './my-module'
192
189
 
193
190
  import sendScriptApi from 'sendscript/api.mjs'
194
191
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sendscript",
3
- "version": "0.1.1",
3
+ "version": "0.1.3",
4
4
  "description": "Blur the line between server and client code.",
5
5
  "module": true,
6
6
  "main": "index.mjs",