TypeScript SDK API improvements #101
Merged
Conversation
This file contains hidden or 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
psrvere
changed the title
penberg
changed the title
jussisaurio
reviewed
Dec 20, 2025
sdk/typescript/src/errors.ts
Outdated
| } | ||
|
|
||
| export function createFsError(params: { | ||
| code: string; |
There was a problem hiding this comment.
I think our lives would be easier if these were string unions like type FsErrorCode = 'ENOENT' | 'EISDIR' | 'EINVAL' ..., same for syscall. TypeScript type system is really powerful, let's use it
There was a problem hiding this comment.
btw you can just tell claude to do this and it'll do it in 1 minute
Contributor
Author
There was a problem hiding this comment.
@jussisaurio - that makes sense. I have added the type definitions.
- added two new APIs - mkdir and rm - renamed deleteFile API to unlink for consistency with node APIs. Keeping deleteFile API for backward compatability - added better error checking across all exisitng APIs - added guards.ts file to keep all assertion functions in one place - minor refactoring in filesystem.ts file Signed-off-by: Prateek Singh Rathore <[email protected]>
Signed-off-by: Prateek Singh Rathore <[email protected]>
- used copyfile as syscall as node API uses it - updated metadata in the copy process - if destination exists, it is overwritten Signed-off-by: Prateek Singh Rathore <[email protected]>
It only checks if path exists and doesn't check for permissions. Signed-off-by: Prateek Singh Rathore <[email protected]>
psrvere
force-pushed
the
improve-api-coverage
branch
from
abace67 to
3acca97
Compare
Signed-off-by: Prateek Singh Rathore <[email protected]>
penberg
added a commit
that referenced
this pull request
Dec 29, 2025
Adjust Python bindings with new changes - #101
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Closes #76
guards.tsfile to keep all assertion functions in one placefilesystem.tsfileFollowing table summarizes changes I have made and existing parity gaps with node APIs:
readFile(path, options?)readFile(path, options?)writeFile(path, data, options?)writeFile(path, content, options?)ENOENT)readdir(path, options?)readdir(path)unlink(path)unlink(path)(alias:deleteFile(path))stat(path, options?)stat(path)mkdir(path, options?)mkdir(path)rm(path, options)rm(path, options)force+recursiveoptions, error handlingmaxRetries,retryDelay)rmdir(path, options?)rmdir(path)rename(oldPath, newPath)rename(oldPath, newPath)copyFile(src, dest, mode?)copyFile(src, dest)access(path, mode?)access(path)appendFile(path, data, options?)open(path, flags, mode?)truncate(path, len?)I decided to skip appendFile, open and truncate APIs as it felt like an overkill for current usage. I have left it here for documentation reasons. Please let me know if you disagree.