Skip to content

Commit d055602

Browse files
authored
fix(api-request-builder): Change orderNumber to string (#1599)
1 parent 397f5b4 commit d055602

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

packages/api-request-builder/src/query-id.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,12 @@ export function byCustomerId(custId: string): Object {
7373
* Set the given `orderNumber` to the `orderNumber` internal state of the service instance.
7474
* For querying orders
7575
*
76-
* @param {number} orderNumber - An order number
76+
* @param {string} orderNumber - An order number
7777
* @throws If `orderNumber` is missing or invalid
7878
* @return {Object} The instance of the service, can be chained.
7979
*/
80-
export function byOrderNumber(orderNumber: number): Object {
81-
if (typeof orderNumber !== 'number')
80+
export function byOrderNumber(orderNumber: string): Object {
81+
if (typeof orderNumber !== 'string')
8282
throw new Error(
8383
'Required argument for `byOrderNumber` is missing or invalid'
8484
)

packages/api-request-builder/test/create-service.spec.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ describe('createService', () => {
425425
})
426426

427427
test('should mix orderNumber and queryParams', () => {
428-
expect(service.byOrderNumber(123).expand('baz').build()).toBe(
428+
expect(service.byOrderNumber('123').expand('baz').build()).toBe(
429429
'/my-project1/test/order-number=123?expand=baz'
430430
)
431431
})

packages/api-request-builder/test/query-id.spec.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ describe('queryId', () => {
4141
})
4242

4343
test('should set the orderNumber param', () => {
44-
service.byOrderNumber(123)
45-
expect(service.params.orderNumber).toBe(123)
44+
service.byOrderNumber('123')
45+
expect(service.params.orderNumber).toBe('123')
4646
})
4747

4848
test('should throw if orderNumber is missing', () => {
@@ -52,7 +52,7 @@ describe('queryId', () => {
5252
})
5353

5454
test('should throw if orderNumber is invalid', () => {
55-
expect(() => service.byOrderNumber('hi')).toThrow(
55+
expect(() => service.byOrderNumber(123)).toThrow(
5656
/Required argument for `byOrderNumber` is missing/
5757
)
5858
})

0 commit comments

Comments
 (0)