Open
Conversation
- Replace GitProcess class with standalone exec, spawn, parseError functions - Update Node.js requirement from v12 to v18 - Document new options: encoding, signal (AbortController), killSignal, maxBuffer - Add ExecError, IGitSpawnOptions, IGitStringResult, IGitBufferResult types - Add cancellation examples using AbortController - Update environment variable types to Record<string, string | undefined> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Updates all documentation to reflect the v3.0.0 API changes.
Changes
API Updates
GitProcessclass with standalone functions:exec,spawn,parseErrorIGitSpawnExecutionOptionstoIGitSpawnOptionsenvtype from genericobjecttoRecord<string, string | undefined>New Features Documented
AbortController/AbortSignalsupport for cancellationencodingoption for Buffer output (IGitStringResult,IGitBufferResult)ExecErrorclass for execution failureskillSignalandmaxBuffer(now defaults toInfinity) optionsOther Updates