@progress/kendo-angular-upload 19.1.2-develop.1 → 19.1.2-develop.3

package/events/success-event.d.ts

@@ -7,24 +7,18 @@ import { FileInfo, OperationType } from '../types';
 import { PreventableEvent } from './preventable-event';
 /**
  * Arguments for the `success` event. The `success` event fires when
- * the selected files are successfully uploaded or removed.
+ * you successfully upload or remove the selected files.
  *
- * ```ts-no-run
+ * ```typescript
  *  @Component({
- *    selector: 'my-upload',
  *    template: `
  *    <kendo-upload
- *      [saveUrl]="uploadSaveUrl"
- *      [removeUrl]="uploadRemoveUrl"
  *      (success)="successEventHandler($event)">
  *    </kendo-upload>
  *    `
  *  })
  *  export class UploadComponent {
- *    uploadSaveUrl = 'saveUrl'; // should represent an actual API endpoint
- *    uploadRemoveUrl = 'removeUrl'; // should represent an actual API endpoint
- *
- *    successEventHandler(e: SuccessEvent) {
+ *    public successEventHandler(e: SuccessEvent) {
  *      console.log('The ' + e.operation + ' was successful!');
  *    }
  *  }
@@ -32,15 +26,15 @@ import { PreventableEvent } from './preventable-event';
  */
 export declare class SuccessEvent extends PreventableEvent {
     /**
-     * The list of the files that were uploaded or removed.
+     * The files that you successfully uploaded or removed.
      */
     files: Array<FileInfo>;
     /**
-     * The operation type (`upload` or `remove`).
+     * The operation type that succeeded (`upload` or `remove`).
      */
     operation: OperationType;
     /**
-     * The response object returned by the server.
+     * The HTTP response that the server returns to confirm success.
      */
     response: HttpResponse<any>;
     /**

package/events/upload-event.d.ts

@@ -6,25 +6,19 @@ import { HttpHeaders } from '@angular/common/http';
 import { FileInfo } from '../types';
 import { PreventableEvent } from './preventable-event';
 /**
- * Arguments for the `upload` event. The `upload` event fires when one or more files are about
- * to be uploaded. If you cancel the event, the upload is prevented. You can add headers to the request.
+ * Arguments for the `upload` event. The `upload` event fires when you are about
+ * to upload one or more files. You can cancel this event to prevent upload and add headers to the request.
  *
- * ```ts-no-run
+ * ```typescript
  *  @Component({
- *    selector: 'my-upload',
  *    template: `
  *    <kendo-upload
- *      [saveUrl]="uploadSaveUrl"
- *      [removeUrl]="uploadRemoveUrl"
  *      (upload)="uploadEventHandler($event)">
  *    </kendo-upload>
  *    `
  *  })
  *  export class UploadComponent {
- *    uploadSaveUrl = 'saveUrl'; // should represent an actual API endpoint
- *    uploadRemoveUrl = 'removeUrl'; // should represent an actual API endpoint
- *
- *    uploadEventHandler(e: UploadEvent) {
+ *    public uploadEventHandler(e: UploadEvent) {
  *      e.headers = e.headers.append('X-Foo', 'Bar');
  *    }
  *  }
@@ -32,38 +26,17 @@ import { PreventableEvent } from './preventable-event';
  */
 export declare class UploadEvent extends PreventableEvent {
     /**
-     * The optional object that is sent to the `upload` handler in the form of key/value pair.
-     *
-     * ```ts-no-run
-     *  @Component({
-     *    selector: 'my-upload',
-     *    template: `
-     *    <kendo-upload
-     *      [saveUrl]="uploadSaveUrl"
-     *      [removeUrl]="uploadRemoveUrl"
-     *      (upload)="uploadEventHandler($event)">
-     *    </kendo-upload>
-     *    `
-     *  })
-     *  export class UploadComponent {
-     *    uploadSaveUrl = 'saveUrl'; // should represent an actual API endpoint
-     *    uploadRemoveUrl = 'removeUrl'; // should represent an actual API endpoint
+     * The optional object that you send to the `upload` handler as key/value pairs.
      *
-     *    uploadEventHandler(e: UploadEvent) {
-     *      e.data = {
-     *        description: 'File description'
-     *      };
-     *    }
-     *  }
-     * ```
      */
     data: Object;
     /**
-     * The list of the files that will be uploaded.
+     * The files that you will upload to the server.
      */
     files: Array<FileInfo>;
     /**
      * The headers of the request.
+     * You can use this to add custom headers to the upload request.
      */
     headers: HttpHeaders;
     /**

package/events/upload-progress-event.d.ts

@@ -5,24 +5,18 @@
 import { FileInfo } from '../types';
 /**
  * Arguments for the `uploadprogress` event. The `uploadprogress` event
- * fires when the files are in the process of uploading.
+ * fires when you upload files.
  *
- * ```ts-no-run
+ * ```typescript
  *  @Component({
- *    selector: 'my-upload',
  *    template: `
  *    <kendo-upload
- *      [saveUrl]="uploadSaveUrl"
- *      [removeUrl]="uploadRemoveUrl"
  *      (uploadProgress)="uploadProgressEventHandler($event)">
  *    </kendo-upload>
  *    `
  *  })
  *  export class UploadComponent {
- *    uploadSaveUrl = 'saveUrl'; // should represent an actual API endpoint
- *    uploadRemoveUrl = 'removeUrl'; // should represent an actual API endpoint
- *
- *    uploadProgressEventHandler(e: UploadProgressEvent) {
+ *    public uploadProgressEventHandler(e: UploadProgressEvent) {
  *      console.log(e.files[0].name + ' is ' + e.percentComplete + ' uploaded');
  *    }
  *  }
@@ -30,11 +24,11 @@ import { FileInfo } from '../types';
  */
 export declare class UploadProgressEvent {
     /**
-     * The list of files that are being uploaded.
+     * The files that you are currently uploading.
      */
     files: Array<FileInfo>;
     /**
-     * The portion that has been uploaded.
+     * The upload progress as a percentage from 0 to 100.
      */
     percentComplete: number;
     /**