code-suggester
Version:
Library to propose code changes
17 lines (16 loc) • 970 B
TypeScript
import { CreatePullRequest, CreatePullRequestUserOptions, CreateReviewComment, CreateReviewCommentUserOptions } from './types';
/**
* Add defaults to GitHub Pull Request options.
* Preserves the empty string.
* For ESCMAScript, null/undefined values are preserved for required fields.
* Recommended with an object validation function to check empty strings and incorrect types.
* @param {PullRequestUserOptions} options the user-provided github pull request options
* @returns {CreatePullRequest} git hub context with defaults applied
*/
export declare function addPullRequestDefaults(options: CreatePullRequestUserOptions): CreatePullRequest;
/**
* Format user input for pull request review comments
* @param options The user's options input for review comments
* @returns the formatted version of user input for pull request review comments
*/
export declare function addReviewCommentsDefaults(options: CreateReviewCommentUserOptions): CreateReviewComment;