Typed library #29
Open
Typed library #29
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tshemsedinov
requested changes
Oct 25, 2020
There was a problem hiding this comment.
- Please move all typings to
/types, see example: https://github.com/metarhia/metatests - Add https://www.npmjs.com/package/@types/node to dependencies for builtin node.js libraries, for example
BaseOptions - Use interfaces in most cases
lib/loader.d.ts
Outdated
| import { BaseOptions } from 'vm'; | ||
| import { MetaScript } from './vm'; | ||
|
|
||
| export declare const readScript: ( |
There was a problem hiding this comment.
Suggested change
| export declare const readScript: ( | |
| export declare { | |
| function readScript( |
lib/vm.d.ts
Outdated
Comment on lines
5
to
18
| type VMCtxNodeKeys = | ||
| | 'Buffer' | ||
| | 'console' | ||
| | 'queueMicrotask' | ||
| | 'setTimeout' | ||
| | 'setImmediate' | ||
| | 'setInterval' | ||
| | 'clearTimeout' | ||
| | 'clearImmediate' | ||
| | 'clearInterval'; | ||
|
|
||
| type VMContextNodeTypes = { | ||
| [key in VMCtxNodeKeys]: NodeJS.Global[key]; | ||
| }; |
There was a problem hiding this comment.
We don't need to specify this certain list
lib/vm.d.ts
Outdated
| [key in VMCtxNodeKeys]: NodeJS.Global[key]; | ||
| }; | ||
|
|
||
| type VMContextLibDOMTypes = { |
There was a problem hiding this comment.
Use interfaces instead of types
lib/vm.d.ts
Outdated
| constructor( | ||
| name: string, | ||
| src: string, | ||
| options?: vm.ScriptOptions & { context: vm.Context } |
There was a problem hiding this comment.
Need new interface for options
lib/vm.d.ts
Outdated
Comment on lines
47
to
51
| export declare const createScript: ( | ||
| name: string, | ||
| src: string, | ||
| options?: vm.ScriptOptions & { context: vm.Context } | ||
| ) => MetaScript; |
There was a problem hiding this comment.
Suggested change
| export declare const createScript: ( | |
| name: string, | |
| src: string, | |
| options?: vm.ScriptOptions & { context: vm.Context } | |
| ) => MetaScript; | |
| function createScript(name: string, src: string, options?: MetaOptions): MetaScript; |
|
Tried replacing the parts you emphasized on. May I ask why would it be necessary to stick with interfaces? I was pretty concerned that the "type" structure is more powerful until now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello, please review the typings I wrote and approve if valid.