Skip to content

Commit 4142d03

Browse files
authored
add string type to compass gravity (#516)
1 parent 67b2a3c commit 4142d03

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

__TESTS__/unit/values/gravity/CompassGravity.test.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,8 @@ describe('Tests for Compass Gravity', () => {
1515
expect(Gravity.compass(Compass.southEast()).toString()).toBe('g_south_east');
1616
expect(Gravity.compass(Compass.northEast()).toString()).toBe('g_north_east');
1717
});
18+
19+
it('Should accept string as input', () => {
20+
expect(Gravity.compass('north_west').toString()).toBe('g_north_west');
21+
});
1822
});

src/qualifiers/gravity.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import {XYCenterGravity} from "./gravity/xyCenterGravity/XYCenterGravity.js";
1010
* @description Defines the gravity based on directional values from a compass.
1111
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_transformations#control_gravity|Control gravity for images}
1212
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_transformations#control_gravity|Control gravity for videos}
13-
* @param {Qualifiers.Compass} direction A compass Values
13+
* @param {Qualifiers.Compass | string} direction A compass Values
1414
* @memberOf Qualifiers.Gravity
1515
* @example
1616
* import {Cloudinary} from "@cloudinary/url-gen";
@@ -23,7 +23,7 @@ import {XYCenterGravity} from "./gravity/xyCenterGravity/XYCenterGravity.js";
2323
* image.resize(crop().width(300).gravity(compass(north())))
2424
* @return {CompassGravity}
2525
*/
26-
function compass(direction: CompassQualifier): CompassGravity {
26+
function compass(direction: CompassQualifier | string): CompassGravity {
2727
return new CompassGravity(direction);
2828
}
2929

src/qualifiers/gravity/compassGravity/CompassGravity.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ type ICompassGravity = 'north' | 'center' | 'east' | 'west' | 'south' | 'north_w
1010
*/
1111
class CompassGravity extends GravityQualifier {
1212
private type:'gravity';
13-
constructor(dir: CompassQualifier) {
13+
constructor(dir: CompassQualifier | string) {
1414
// Required due to https://github.com/microsoft/TypeScript/issues/13029
1515
/* istanbul ignore next */
1616
super(dir);

0 commit comments

Comments
 (0)