check-param-names (#18189)

This commit is contained in:
Charles Gagnon
2022-01-31 12:39:22 -08:00
committed by GitHub
parent 7149bbd591
commit 1c9ba64ee0
47 changed files with 96 additions and 80 deletions

View File

@@ -142,7 +142,7 @@ export enum Endpoint {
/**
* Gets the localized text to display for a corresponding endpoint
* @param serviceName The endpoint name to get the display text for
* @param endpointName The endpoint name to get the display text for
* @param description The backup description to use if we don't have our own
*/
function getEndpointDisplayText(endpointName?: string, description?: string): string {

View File

@@ -34,12 +34,17 @@ export function hdfsFileTypeToFileType(hdfsFileType: HdfsFileType | undefined):
export class FileStatus {
/**
*
* @param owner The ACL entry object for the owner permissions
* @param accessTime
* @param blockSize
* @param group The ACL entry object for the group permissions
* @param other The ACL entry object for the other permissions
* @param stickyBit The sticky bit status for the object. If true the owner/root are
* the only ones who can delete the resource or its contents (if a folder)
* @param aclEntries The ACL entries defined for the object
* @param length
* @param modificationTime
* @param owner The ACL entry object for the owner permissions
* @param pathSuffix
* @param permission
* @param replication
* @param snapshotEnabled
* @param type
*/
constructor(
/**

View File

@@ -108,7 +108,6 @@ export class WebHDFS {
* Gets status message from response
*
* @param response response object
* @param strict If set true then RemoteException must be present in the body
* @returns Error message interpreted by status code
*/
private getStatusMessage(response: request.Response): string {
@@ -211,6 +210,7 @@ export class WebHDFS {
* Send a request to WebHDFS REST API
*
* @param method HTTP method
* @param urlValue
* @param opts Options for request
* @returns void
*/
@@ -319,8 +319,10 @@ export class WebHDFS {
/**
* Change file owner
*
* @param path
* @param userId User name
* @param groupId Group name
* @param callback
* @returns void
*/
public chown(path: string, userId: string, groupId: string, callback: (error: HdfsError) => void): void {
@@ -511,7 +513,7 @@ export class WebHDFS {
* Set ACL for the given path. The owner, group and other fields are required - other entries are optional.
* @param path The path to the file/folder to set the ACL on
* @param fileType The type of file we're setting to determine if defaults should be applied. Use undefined if type is unknown
* @param ownerEntry The status containing the permissions to set
* @param permissionStatus The status containing the permissions to set
* @param callback Callback to handle the response
*/
public setAcl(path: string, fileType: FileType | undefined, permissionStatus: PermissionStatus, callback: (error: HdfsError) => void): void {
@@ -592,7 +594,11 @@ export class WebHDFS {
/**
* Write data to the file
*
* @param path
* @param data
* @param append If set to true then append data to the file
* @param opts
* @param callback
*/
public writeFile(path: string, data: string | Buffer, append: boolean, opts: object,
callback: (error: HdfsError) => void): fs.WriteStream {
@@ -663,8 +669,9 @@ export class WebHDFS {
* Create writable stream for given path
*
* @fires WebHDFS#finish
* @param [append] If set to true then append data to the file
*
* @param path
* @param append If set to true then append data to the file
* @param opts
* @example
* let hdfs = WebHDFS.createClient();
*

View File

@@ -379,8 +379,7 @@ class HdfsFileSource implements IFileSource {
* Sets the ACL status for given path
* @param path The path to the file/folder to set the ACL on
* @param fileType The type of file we're setting to determine if defaults should be applied. Use undefined if type is unknown
* @param ownerEntry The status containing the permissions to set
* @param aclEntries The ACL entries to set
* @param permissionStatus The permissions to set
*/
public setAcl(path: string, fileType: FileType | undefined, permissionStatus: PermissionStatus): Promise<void> {
return new Promise((resolve, reject) => {

View File

@@ -42,7 +42,6 @@ export function getAppDataPath() {
/**
* Get a file name that is not already used in the target directory
* @param filePath source notebook file name
* @param fileExtension file type
*/
export function findNextUntitledEditorName(filePath: string): string {
const fileExtension = path.extname(filePath);