From 63e610b1b63b0b16a0c182b19a900dd114c8e843 Mon Sep 17 00:00:00 2001 From: Anna Tomanek Date: Fri, 18 Oct 2019 10:34:40 +0200 Subject: [PATCH] Docs: Image upload API docs corrected. [skip ci] --- src/imageupload.js | 8 ++++---- src/imageupload/imageuploadcommand.js | 2 +- src/imageupload/imageuploadediting.js | 10 +++++----- src/imageupload/utils.js | 28 +++++++++++++-------------- 4 files changed, 24 insertions(+), 24 deletions(-) diff --git a/src/imageupload.js b/src/imageupload.js index f750ff4a..b7386ebe 100644 --- a/src/imageupload.js +++ b/src/imageupload.js @@ -65,9 +65,9 @@ export default class ImageUpload extends Plugin { */ /** - * List of accepted image types. + * The list of accepted image types. * - * The accepted types of images can be customize to allow only certain types of images: + * The accepted types of images can be customized to allow only certain types of images: * * // Allow only JPEG and PNG images: * const imageUploadConfig = { @@ -75,10 +75,10 @@ export default class ImageUpload extends Plugin { * }; * * The type string should match [one of the sub-types](https://www.iana.org/assignments/media-types/media-types.xhtml#image) - * of the image mime-type. E.g. for the `image/jpeg` mime-type add `'jpeg'`. + * of the image MIME type. E.g. for the `image/jpeg` MIME type, add `'jpeg'` to your image upload configuration. * * **Note:** This setting only restricts some image types to be selected and uploaded through the CKEditor UI and commands. Image type - * recognition and filtering should be also implemented on the server which accepts image uploads + * recognition and filtering should also be implemented on the server which accepts image uploads. * * @member {Array.} module:image/imageupload~ImageUploadConfig#types * @default [ 'jpeg', 'png', 'gif', 'bmp', 'webp', 'tiff' ] diff --git a/src/imageupload/imageuploadcommand.js b/src/imageupload/imageuploadcommand.js index de8fae4d..15f97703 100644 --- a/src/imageupload/imageuploadcommand.js +++ b/src/imageupload/imageuploadcommand.js @@ -12,7 +12,7 @@ import { insertImage, isImageAllowed } from '../image/utils'; */ /** - * Image upload command. + * The image upload command. * * The command is registered by the {@link module:image/imageupload/imageuploadediting~ImageUploadEditing} plugin as `'imageUpload'`. * diff --git a/src/imageupload/imageuploadediting.js b/src/imageupload/imageuploadediting.js index d68696df..b3083c06 100644 --- a/src/imageupload/imageuploadediting.js +++ b/src/imageupload/imageuploadediting.js @@ -186,10 +186,10 @@ export default class ImageUploadEditing extends Plugin { } /** - * Read and upload an image. + * Reads and uploads an image. * - * The image is read from the disk and as a base64 encoded string it is set temporarily to - * `image[src]`. When the image is successfully uploaded the temporary data is replaced with the target + * The image is read from the disk and as a Base64-encoded string it is set temporarily to + * `image[src]`. When the image is successfully uploaded, the temporary data is replaced with the target * image's URL (the URL to the uploaded image on the server). * * @protected @@ -291,11 +291,11 @@ export default class ImageUploadEditing extends Plugin { } /** - * Creates `srcset` attribute based on a given file upload response and sets it as an attribute to a specific image element. + * Creates the `srcset` attribute based on a given file upload response and sets it as an attribute to a specific image element. * * @protected * @param {Object} data Data object from which `srcset` will be created. - * @param {module:engine/model/element~Element} image The image element on which `srcset` attribute will be set. + * @param {module:engine/model/element~Element} image The image element on which the `srcset` attribute will be set. * @param {module:engine/model/writer~Writer} writer */ _parseAndSetSrcsetAttributeOnImage( data, image, writer ) { diff --git a/src/imageupload/utils.js b/src/imageupload/utils.js index 8bb65268..2dd90b5b 100644 --- a/src/imageupload/utils.js +++ b/src/imageupload/utils.js @@ -10,7 +10,7 @@ /* global fetch, File */ /** - * Creates a RegExp used to test for image files. + * Creates a regular expression used to test for image files. * * const imageType = createImageTypeRegExp( [ 'png', 'jpeg', 'svg+xml', 'vnd.microsoft.icon' ] ); * @@ -20,18 +20,18 @@ * @returns {RegExp} */ export function createImageTypeRegExp( types ) { - // Sanitize mime-type name which may include: "+", "-" or ".". + // Sanitize the MIME type name which may include: "+", "-" or ".". const regExpSafeNames = types.map( type => type.replace( '+', '\\+' ) ); return new RegExp( `^image\\/(${ regExpSafeNames.join( '|' ) })$` ); } /** - * Creates a promise which fetches the image local source (base64 or blob) and resolves with a `File` object. + * Creates a promise that fetches the image local source (Base64 or blob) and resolves with a `File` object. * - * @param {module:engine/view/element~Element} image Image which source to fetch. - * @returns {Promise.} A promise which resolves when image source is fetched and converted to `File` instance. - * It resolves with a `File` object. If there were any errors during file processing the promise will be rejected. + * @param {module:engine/view/element~Element} image Image whose source to fetch. + * @returns {Promise.} A promise which resolves when an image source is fetched and converted to a `File` instance. + * It resolves with a `File` object. If there were any errors during file processing, the promise will be rejected. */ export function fetchLocalImage( image ) { return new Promise( ( resolve, reject ) => { @@ -53,9 +53,9 @@ export function fetchLocalImage( image ) { } /** - * Checks whether given node is an image element with local source (base64 or blob). + * Checks whether a given node is an image element with a local source (Base64 or blob). * - * @param {module:engine/view/node~Node} node Node to check. + * @param {module:engine/view/node~Node} node The node to check. * @returns {Boolean} */ export function isLocalImage( node ) { @@ -67,9 +67,9 @@ export function isLocalImage( node ) { node.getAttribute( 'src' ).match( /^blob:/g ); } -// Extracts image type based on its blob representation or its source. +// Extracts an image type based on its blob representation or its source. // -// @param {String} src Image src attribute value. +// @param {String} src Image `src` attribute value. // @param {Blob} blob Image blob representation. // @returns {String} function getImageMimeType( blob, src ) { @@ -83,11 +83,11 @@ function getImageMimeType( blob, src ) { } } -// Creates `File` instance from the given `Blob` instance using specified filename. +// Creates a `File` instance from the given `Blob` instance using the specified file name. // -// @param {Blob} blob The `Blob` instance from which file will be created. -// @param {String} filename Filename used during file creation. -// @param {String} mimeType File mime type. +// @param {Blob} blob The `Blob` instance from which the file will be created. +// @param {String} filename The file name used during the file creation. +// @param {String} mimeType The file MIME type. // @returns {File|null} The `File` instance created from the given blob or `null` if `File API` is not available. function createFileFromBlob( blob, filename, mimeType ) { try {