Add TypeScript definition #15

DenisCarriere · 2018-08-20T19:56:44Z

Add TypeScript definition for load-json-file

Ref: https://github.com/sindresorhus/typescript-definition-style-guide
sindresorhus/ama#439 (comment)

DenisCarriere · 2018-08-20T19:57:20Z

Issue again with xo handling Typescript definitions

$ npm t

> [email protected] test /Users/denis/Github/load-json-file
> xo && ava


  index.d.ts:1:1
  ✖  1:1  Parsing error: The keyword interface is reserved

  1 error
npm ERR! Test failed.  See above for more details.

DenisCarriere · 2018-08-20T21:08:51Z

Updated PR based on comments from => sindresorhus/write-json-file#17

CC: @sindresorhus

SamVerschueren · 2018-08-21T09:50:48Z

index.d.ts

+ * 	console.log('done');
+ * })();
+ */
+export default function loadJsonFile(filepath: string, options?: Options): Promise<void>;


It returns a Promise<any>. What we can do however is make it generic like this

export default function loadJsonFile<T = any>(filepath: string, options?: Options): Promise<T>;

Then the user can supply the type that it returns.

interface Foo { value: string; } const data = await loadJsonFile<Foo>('data.json'); //=> data is typed as `Foo`

👍 you're correct, it doesn't return Promise<void> 🤦‍♂️

I like using the generic approach 👍

SamVerschueren · 2018-08-21T09:51:11Z

index.d.ts

+ * loadJsonFile.sync('foo.json')
+ * console.log(json);
+ */
+export function sync(filepath: string, options?: Options): void;


Same as below, it returns an any object but we can make it a generic.

SamVerschueren · 2018-08-21T09:51:31Z

index.d.ts

+ * @example
+ * import * as loadJsonFile from 'load-json-file';
+ *
+ * loadJsonFile.sync('foo.json')


const json = loadJsonFile.sync('foo.json');

SamVerschueren · 2018-08-21T09:52:00Z

index.d.ts

+ *
+ * (async () => {
+ * 	await loadJsonFile('foo.json');
+ * 	console.log('done');


Should we use the same example as above and do console.log(json) instead? Because the functionality is the same, it's just async.

Agreed! I've updated both examples to reflect the same logic

DenisCarriere · 2018-08-21T17:21:50Z

@SamVerschueren Pushed updates based on your comments.

Thanks for reviewing!

SamVerschueren

Added two extra comments. Thanks for working on this!

SamVerschueren · 2018-08-21T18:16:31Z

index.d.ts

+	/**
+	 * Applies a function to the JSON string before parsing.
+	 */
+	beforeParse?: Function


I think we can be more specific on what the Function is and should return.

beforeParse?: (data: string) => string;

Totally agree 😄

SamVerschueren · 2018-08-21T18:20:27Z

index.d.ts

+	 * Prescribes how the value originally produced by parsing is transformed, before being returned.
+	 * See the [JSON.parse docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Using_the_reviver_parameter) for more.
+	 */
+	reviver?: Function


Same as above, we can be more specific.

reviver?: (key: string, value: any) => any;

👍 agreed

DenisCarriere · 2018-08-21T18:40:47Z

@SamVerschueren Updated Function

SamVerschueren

Looks good to me!

sindresorhus · 2018-08-27T08:40:22Z

index.d.ts

+ * @example
+ * import * as loadJsonFile from 'load-json-file';
+ *
+ * const json = loadJsonFile.sync('foo.json')


sindresorhus · 2018-08-27T08:40:30Z

index.d.ts

+ * import * as loadJsonFile from 'load-json-file';
+ *
+ * const json = loadJsonFile.sync('foo.json')
+ * console.log(json);


Let's drop the console.log

sindresorhus · 2018-08-27T08:41:19Z

index.d.ts

+ * 	//=> {foo: true}
+ * })();
+ */
+export default function loadJsonFile<T = any>(filepath: string, options?: Options): Promise<T>;


Should we use unknown here instead of any?

🤔 unknown isn't a type in Typescript, any would be considered the "unknown" since any can be applied to anything.

Oh I didn't know this was a new type in Typescript 3.x

https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-0.html

Learn something every day!

sindresorhus · 2018-08-27T08:46:27Z

index.d.ts

+ * console.log(json);
+ * //=> {foo: true}
+ */
+export function sync<T = any>(filepath: string, options?: Options): T;


filepath => filePath (I plan to make the same change in the code and docs after merging this)

SamVerschueren

Can you add tsd-check? For an example, see write-json-file.

DenisCarriere · 2018-09-06T05:53:01Z

@SamVerschueren Sure I'll try to get something started, it won't be as elaborate as yours, but at least it will be a start

SamVerschueren · 2018-09-06T06:16:02Z

package.json

 	},
 	"devDependencies": {
 		"ava": "*",
+		"tsd-check": "^0.1.0",


I just released a new version (0.2.1) which supports top-level await.

👍 awesome! Changed it to "*"

sindresorhus · 2018-09-07T09:13:03Z

index.d.ts

+ * 	//=> {foo: true}
+ * })();
+ */
+export default function loadJsonFile<T = any>(filePath: string, options?: Options): Promise<T>;


I think we should use unknown instead of any so users are forced to explicitly coerce it. Thoughts?

👍 unknown works as the default

Very cool advanced type from Typescript 3.x

DenisCarriere · 2018-09-12T19:33:49Z

@sindresorhus @SamVerschueren anything else to review on this PR?

sindresorhus · 2018-09-18T05:17:38Z

Looks good. Thanks for your work and patience :)

Add Typescript Definition

a9f2804

DenisCarriere added 6 commits August 20, 2018 16:10

Update based on comments

c8ae085

Update based on comments

302aa2a

Add dot & ignore xo

f3b32c0

Remove {void} & fix indentation

2bbbe34

Fix example

129e058

Change module.export => module.exports

017faad

DenisCarriere mentioned this pull request Aug 20, 2018

Add TypeScript definition and require Node.js 6 sindresorhus/write-json-file#17

Merged

Fix import

a3f21f9

SamVerschueren suggested changes Aug 21, 2018

View reviewed changes

Update @example & include generic T=any

d3dad7b

SamVerschueren suggested changes Aug 21, 2018

View reviewed changes

Expand Function details

26c0380

Export optional types

2584c36

SamVerschueren approved these changes Aug 21, 2018

View reviewed changes

sindresorhus changed the title ~~Add Typescript Definition~~ Add TypeScript definition Aug 27, 2018

sindresorhus reviewed Aug 27, 2018

View reviewed changes

Update index.d.ts

8b792d6

sindresorhus requested changes Aug 27, 2018

View reviewed changes

sindresorhus reviewed Aug 27, 2018

View reviewed changes

DenisCarriere added 3 commits August 29, 2018 15:19

Update changes @sindresorhus

bbe8b24

Merge branch 'master' of github.com:DenisCarriere/load-json-file

534fd39

Add extra return after @example

d2bd1d7

SamVerschueren suggested changes Sep 6, 2018

View reviewed changes

Add index.test-d.ts

c95f14f

SamVerschueren suggested changes Sep 6, 2018

View reviewed changes

sindresorhus reviewed Sep 7, 2018

View reviewed changes

sindresorhus and others added 5 commits September 7, 2018 16:15

Update package.json

e198adb

Update package.json

9c96144

Change any to unknown

2a11d5d

Update package.json

3ad168d

Update index.test-d.ts

a67eb2d

Update index.test-d.ts

1dfeeef

sindresorhus approved these changes Sep 18, 2018

View reviewed changes

sindresorhus merged commit a58cdf3 into sindresorhus:master Sep 18, 2018

Uh oh!

Add TypeScript definition #15

Add TypeScript definition #15

Uh oh!

Conversation

DenisCarriere commented Aug 20, 2018

Uh oh!

DenisCarriere commented Aug 20, 2018

Uh oh!

DenisCarriere commented Aug 20, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DenisCarriere commented Aug 21, 2018

Uh oh!

SamVerschueren left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DenisCarriere commented Aug 21, 2018

Uh oh!

SamVerschueren left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sindresorhus Aug 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DenisCarriere Aug 29, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SamVerschueren left a comment

Choose a reason for hiding this comment

Uh oh!

DenisCarriere commented Sep 6, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DenisCarriere commented Sep 12, 2018

Uh oh!

sindresorhus commented Sep 18, 2018

Uh oh!

sindresorhus Aug 27, 2018 •

edited

Loading

DenisCarriere Aug 29, 2018 •

edited

Loading