Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion src/actions/namedTransformation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,23 @@ import {NamedTransformationAction} from "./namedTransformation/NamedTransformati
* Applies a pre-defined named transformation of the given name.
* @memberOf Actions
* @namespace NamedTransformation
* @example
* import {Cloudinary} from "@cloudinary/base/instance/Cloudinary";
* import {name} from "@cloudinary/base/actions/namedTransformation";
*
* const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
* const image = yourCldInstance.image('woman');
* image.namedTransformation(
* name('my_named_transformation'),
* );
*/

/**
* @summary action
* @description Applies a pre-defined named transformation of the given name.
* @param {string} name Transformation name
* @memberOf Actions.NamedTransformation
* @return {NamedTransformationAction}
* @return {Actions.NamedTransformation.NamedTransformationAction}
*/
function name(name:string): NamedTransformationAction {
return new NamedTransformationAction(name);
Expand Down
10 changes: 10 additions & 0 deletions src/actions/namedTransformation/NamedTransformationAction.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
import {Action} from "../../internal/Action";
import {Qualifier} from "../../internal/qualifier/Qualifier";

/**
* @description Applies a pre-defined named transformation of the given name, used with a builder from {@link Actions.NamedTransformation|Named Transformation}
* @extends {SDK.Action}
* @memberOf Actions.NamedTransformation
* @see Visit {@link Actions.NamedTransformation|Named Transformation} for an example
*/
class NamedTransformationAction extends Action {
/**
*
* @param {string} name The name of the named transformation
*/
constructor(name:string) {
super();
this.addQualifier(new Qualifier('t', name));
Expand Down