New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add types declaration file with entry in package.json #236
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
declare module 'json5' { | ||
type StringifyOptions = Partial<{ | ||
/** | ||
* A function that alters the behavior of the stringification process, or an array of String and Number objects that serve as a whitelist for selecting/filtering the properties of the value object to be included in the JSON5 string. If this value is null or not provided, all properties of the object are included in the resulting JSON5 string. | ||
*/ | ||
replacer: (this: any, key: string, value: any) => any; | ||
geopic marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
/** | ||
* A String or Number object that's used to insert white space into the output JSON5 string for readability purposes. If this is a Number, it indicates the number of space characters to use as white space; this number is capped at 10 (if it is greater, the value is just 10). Values less than 1 indicate that no space should be used. If this is a String, the string (or the first 10 characters of the string, if it's longer than that) is used as white space. If this parameter is not provided (or is null), no white space is used. If white space is used, trailing commas will be used in objects and arrays. | ||
*/ | ||
space: string | number; | ||
|
||
/** | ||
* A String representing the quote character to use when serializing strings. | ||
*/ | ||
quote: string; | ||
}> | ||
|
||
/** | ||
* Parses a JSON5 string, constructing the JavaScript value or object described | ||
* by the string. An optional reviver function can be provided to perform a | ||
* transformation on the resulting object before it is returned. | ||
* @param text The string to parse as JSON5. | ||
* @param reviver If a function, this prescribes how the value originally produced by parsing is transformed, before being returned. | ||
*/ | ||
export function parse(text: string, reviver?: (this: any, key: string, value: any) => any): any; | ||
geopic marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
/** | ||
* Converts a JavaScript value to a JSON5 string, optionally replacing values if a | ||
* replacer function is specified, or optionally including only the specified | ||
* properties if a replacer array is specified. | ||
* @param value The value to convert to a JSON5 string. | ||
* @param replacer A function that alters the behavior of the stringification process, or an array of String and Number objects that serve as a whitelist for selecting/filtering the properties of the value object to be included in the JSON5 string. If this value is null or not provided, all properties of the object are included in the resulting JSON5 string. | ||
* @param space A String or Number object that's used to insert white space into the output JSON5 string for readability purposes. If this is a Number, it indicates the number of space characters to use as white space; this number is capped at 10 (if it is greater, the value is just 10). Values less than 1 indicate that no space should be used. If this is a String, the string (or the first 10 characters of the string, if it's longer than that) is used as white space. If this parameter is not provided (or is null), no white space is used. If white space is used, trailing commas will be used in objects and arrays. | ||
*/ | ||
export function stringify(value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string; | ||
geopic marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
/** | ||
* Converts a JavaScript value to a JSON5 string, optionally replacing values if a | ||
* replacer function is specified, or optionally including only the specified | ||
* properties if a replacer array is specified. | ||
* @param value The value to convert to a JSON5 string. | ||
* @param options An object with the following properties: | ||
* | ||
* `replacer`: Same as the `replacer` parameter. | ||
* | ||
* `space`: Same as the `space` parameter. | ||
* | ||
* `quote`: A String representing the quote character to use when serializing strings. | ||
*/ | ||
geopic marked this conversation as resolved.
Show resolved
Hide resolved
|
||
export function stringify(value: any, options?: StringifyOptions): string; | ||
geopic marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of Partial<> you could mark every entry as optonal with a ?:
replacer?: ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is true, but the reason I used Partial is to avoid having to label each property with a question mark since they are all optional. Do you explicitly want me to use question marks?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have to agree that
Partial
feels odd here, even though it achieves the same goal. For me,Partial
is used when you expect to get a subset of data you normally would get otherwise, like in a PATCH request for example. Specifying each property as optional makes more sense from a documentation standpoint I think.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, no probs. I'll mark each property with a question mark. 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just to return to this,
Partial
does label every property as optional. It's a utility type which simply serves as a shortcut in making every property of an object optional which bypasses having to add a question mark to every one of them. I'll usePartial
because I assume that every property of any object structured in theStringifyOptions
mold will be an optional property.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The use case for
Partial
is to transform an existing type into one that is a partial version of the original. Again, itfeels
odd here. I'd prefer to just be explicit here.