sp-js-provisioning 1.0.4 → 1.1.2

package/lib/handlers/files.d.ts

@@ -1,8 +1,8 @@
-import { HandlerBase } from "./handlerbase";
-import { IFile } from "../schema";
-import { Web } from "@pnp/sp";
-import { ProvisioningContext } from "../provisioningcontext";
-import { IProvisioningConfig } from "../provisioningconfig";
+import { HandlerBase } from './handlerbase';
+import { IFile } from '../schema';
+import { Web } from '@pnp/sp';
+import { ProvisioningContext } from '../provisioningcontext';
+import { IProvisioningConfig } from '../provisioningconfig';
 /**
  * Describes the Features Object Handler
  */
@@ -11,83 +11,83 @@ export declare class Files extends HandlerBase {
     /**
      * Creates a new instance of the Files class
      *
-     * @param {IProvisioningConfig} config Provisioning config
+     * @param config - Provisioning config
      */
     constructor(config: IProvisioningConfig);
     /**
      * Provisioning Files
      *
-     * @param {Web} web The web
-     * @param {IFile[]} files The files  to provision
-     * @param {ProvisioningContext} context Provisioning context
+     * @param web - The web
+     * @param files - The files  to provision
+     * @param context - Provisioning context
      */
-    ProvisionObjects(web: Web, files: IFile[], context: ProvisioningContext): Promise<void>;
+    ProvisionObjects(web: Web, files: IFile[], context?: ProvisioningContext): Promise<void>;
     /**
      * Get blob for a file
      *
-     * @param {IFile} file The file
+     * @param file - The file
      */
-    private getFileBlob(file);
+    private getFileBlob;
     /**
      * Procceses a file
      *
-     * @param {Web} web The web
-     * @param {IFile} file The fileAddError
-     * @param {string} webServerRelativeUrl ServerRelativeUrl for the web
+     * @param web - The web
+     * @param file - The file
+     * @param webServerRelativeUrl - ServerRelativeUrl for the web
      */
-    private processFile(web, file, webServerRelativeUrl);
+    private processFile;
     /**
      * Remove exisiting webparts if specified
      *
-     * @param {string} webServerRelativeUrl ServerRelativeUrl for the web
-     * @param {string} fileServerRelativeUrl ServerRelativeUrl for the file
-     * @param {boolean} shouldRemove Should web parts be removed
+     * @param webServerRelativeUrl - ServerRelativeUrl for the web
+     * @param fileServerRelativeUrl - ServerRelativeUrl for the file
+     * @param shouldRemove - Should web parts be removed
      */
-    private removeExistingWebParts(webServerRelativeUrl, fileServerRelativeUrl, shouldRemove);
+    private removeExistingWebParts;
     /**
      * Processes web parts
      *
-     * @param {IFile} file The file
-     * @param {string} webServerRelativeUrl ServerRelativeUrl for the web
-     * @param {string} fileServerRelativeUrl ServerRelativeUrl for the file
+     * @param file - The file
+     * @param webServerRelativeUrl - ServerRelativeUrl for the web
+     * @param fileServerRelativeUrl - ServerRelativeUrl for the file
      */
-    private processWebParts(file, webServerRelativeUrl, fileServerRelativeUrl);
+    private processWebParts;
     /**
      * Fetches web part contents
      *
-     * @param {Array<IWebPart>} webParts Web parts
-     * @param {Function} callbackFunc Callback function that takes index of the the webpart and the retrieved XML
+     * @param webParts - Web parts
+     * @param callbackFunc - Callback function that takes index of the the webpart and the retrieved XML
      */
     private fetchWebPartContents;
     /**
      * Processes page list views
      *
-     * @param {Web} web The web
-     * @param {Array<IWebPart>} webParts Web parts
-     * @param {string} fileServerRelativeUrl ServerRelativeUrl for the file
+     * @param web - The web
+     * @param webParts - Web parts
+     * @param fileServerRelativeUrl - ServerRelativeUrl for the file
      */
-    private processPageListViews(web, webParts, fileServerRelativeUrl);
+    private processPageListViews;
     /**
      * Processes page list view
      *
-     * @param {Web} web The web
-     * @param {any} listView List view
-     * @param {string} fileServerRelativeUrl ServerRelativeUrl for the file
+     * @param web - The web
+     * @param listView - List view
+     * @param fileServerRelativeUrl - ServerRelativeUrl for the file
      */
-    private processPageListView(web, listView, fileServerRelativeUrl);
+    private processPageListView;
     /**
      * Process list item properties for the file
      *
-     * @param {Web} web The web
-     * @param {File} pnpFile The PnP file
-     * @param {Object} properties The properties to set
+     * @param web - The web
+     * @param pnpFile - The PnP file
+     * @param properties - The properties to set
      */
-    private processProperties(web, pnpFile, file);
+    private processProperties;
     /**
-    * Replaces tokens in a string, e.g. {site}
-    *
-    * @param {string} str The string
-    * @param {SP.ClientContext} ctx Client context
-    */
-    private replaceWebPartXmlTokens(str, ctx);
+     * Replaces tokens in a string, e.g. `{site}`
+     *
+     * @param str - The string
+     * @param ctx - Client context
+     */
+    private replaceWebPartXmlTokens;
 }