Skip to content

Commit 1475911

Browse files
committed
style: fix
1 parent a3c9d50 commit 1475911

File tree

6 files changed

+206
-206
lines changed

6 files changed

+206
-206
lines changed

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@ the passed options and sends the request using [fetch](https://developer.mozilla
4141
```js
4242
request("POST /repos/:owner/:repo/issues/:number/labels", {
4343
mediaType: {
44-
previews: ["symmetra"]
44+
previews: ["symmetra"],
4545
},
4646
owner: "octokit",
4747
repo: "request.js",
4848
number: 1,
49-
labels: ["🐛 bug"]
49+
labels: ["🐛 bug"],
5050
});
5151
```
5252

@@ -102,10 +102,10 @@ const { request } = require("@octokit/request");
102102
// https://developer.github.com/v3/repos/#list-organization-repositories
103103
const result = await request("GET /orgs/:org/repos", {
104104
headers: {
105-
authorization: "token 0000000000000000000000000000000000000001"
105+
authorization: "token 0000000000000000000000000000000000000001",
106106
},
107107
org: "octokit",
108-
type: "private"
108+
type: "private",
109109
});
110110

111111
console.log(`${result.data.length} repos found.`);
@@ -118,7 +118,7 @@ For GraphQL request we recommend using [`@octokit/graphql`](https://github.com/o
118118
```js
119119
const result = await request("POST /graphql", {
120120
headers: {
121-
authorization: "token 0000000000000000000000000000000000000001"
121+
authorization: "token 0000000000000000000000000000000000000001",
122122
},
123123
query: `query ($login: String!) {
124124
organization(login: $login) {
@@ -128,8 +128,8 @@ const result = await request("POST /graphql", {
128128
}
129129
}`,
130130
variables: {
131-
login: "octokit"
132-
}
131+
login: "octokit",
132+
},
133133
});
134134
```
135135

@@ -142,10 +142,10 @@ const result = await request({
142142
method: "GET",
143143
url: "/orgs/:org/repos",
144144
headers: {
145-
authorization: "token 0000000000000000000000000000000000000001"
145+
authorization: "token 0000000000000000000000000000000000000001",
146146
},
147147
org: "octokit",
148-
type: "private"
148+
type: "private",
149149
});
150150
```
151151

@@ -156,8 +156,8 @@ The simplest way to authenticate a request is to set the `Authorization` header
156156
```js
157157
const requestWithAuth = request.defaults({
158158
headers: {
159-
authorization: "token 0000000000000000000000000000000000000001"
160-
}
159+
authorization: "token 0000000000000000000000000000000000000001",
160+
},
161161
});
162162
const result = await request("GET /user");
163163
```
@@ -169,22 +169,22 @@ const { createAppAuth } = require("@octokit/auth-app");
169169
const auth = createAppAuth({
170170
id: process.env.APP_ID,
171171
privateKey: process.env.PRIVATE_KEY,
172-
installationId: 123
172+
installationId: 123,
173173
});
174174
const requestWithAuth = request.defaults({
175175
request: {
176-
hook: auth.hook
176+
hook: auth.hook,
177177
},
178178
mediaType: {
179-
previews: ["machine-man"]
180-
}
179+
previews: ["machine-man"],
180+
},
181181
});
182182

183183
const { data: app } = await requestWithAuth("GET /app");
184184
const { data: app } = await requestWithAuth("POST /repos/:owner/:repo/issues", {
185185
owner: "octocat",
186186
repo: "hello-world",
187-
title: "Hello from the engine room"
187+
title: "Hello from the engine room",
188188
});
189189
```
190190

@@ -416,10 +416,10 @@ const myrequest = require("@octokit/request").defaults({
416416
baseUrl: "https://github-enterprise.acme-inc.com/api/v3",
417417
headers: {
418418
"user-agent": "myApp/1.2.3",
419-
authorization: `token 0000000000000000000000000000000000000001`
419+
authorization: `token 0000000000000000000000000000000000000001`,
420420
},
421421
org: "my-project",
422-
per_page: 100
422+
per_page: 100,
423423
});
424424

425425
myrequest(`GET /orgs/:org/repos`);
@@ -431,14 +431,14 @@ You can call `.defaults()` again on the returned method, the defaults will casca
431431
const myProjectRequest = request.defaults({
432432
baseUrl: "https://github-enterprise.acme-inc.com/api/v3",
433433
headers: {
434-
"user-agent": "myApp/1.2.3"
434+
"user-agent": "myApp/1.2.3",
435435
},
436-
org: "my-project"
436+
org: "my-project",
437437
});
438438
const myProjectRequestWithAuth = myProjectRequest.defaults({
439439
headers: {
440-
authorization: `token 0000000000000000000000000000000000000001`
441-
}
440+
authorization: `token 0000000000000000000000000000000000000001`,
441+
},
442442
});
443443
```
444444

@@ -453,7 +453,7 @@ See https://github.com/octokit/endpoint.js. Example
453453
```js
454454
const options = request.endpoint("GET /orgs/:org/repos", {
455455
org: "my-project",
456-
type: "private"
456+
type: "private",
457457
});
458458

459459
// {
@@ -487,8 +487,8 @@ const response = await request("POST /markdown/raw", {
487487
data: "Hello world github/linguist#1 **cool**, and #1!",
488488
headers: {
489489
accept: "text/html;charset=utf-8",
490-
"content-type": "text/plain"
491-
}
490+
"content-type": "text/plain",
491+
},
492492
});
493493

494494
// Request is sent as
@@ -527,9 +527,9 @@ request(
527527
headers: {
528528
"content-type": "text/plain",
529529
"content-length": 14,
530-
authorization: `token 0000000000000000000000000000000000000001`
530+
authorization: `token 0000000000000000000000000000000000000001`,
531531
},
532-
data: "Hello, world!"
532+
data: "Hello, world!",
533533
}
534534
);
535535
```

src/fetch-wrapper.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ export default function fetchWrapper(
2929
method: requestOptions.method,
3030
body: requestOptions.body,
3131
headers: requestOptions.headers,
32-
redirect: requestOptions.redirect
32+
redirect: requestOptions.redirect,
3333
},
3434
requestOptions.request
3535
)
3636
)
37-
.then(response => {
37+
.then((response) => {
3838
url = response.url;
3939
status = response.status;
4040

@@ -54,25 +54,25 @@ export default function fetchWrapper(
5454

5555
throw new RequestError(response.statusText, status, {
5656
headers,
57-
request: requestOptions
57+
request: requestOptions,
5858
});
5959
}
6060

6161
if (status === 304) {
6262
throw new RequestError("Not modified", status, {
6363
headers,
64-
request: requestOptions
64+
request: requestOptions,
6565
});
6666
}
6767

6868
if (status >= 400) {
6969
return response
7070
.text()
7171

72-
.then(message => {
72+
.then((message) => {
7373
const error = new RequestError(message, status, {
7474
headers,
75-
request: requestOptions
75+
request: requestOptions,
7676
});
7777

7878
try {
@@ -104,23 +104,23 @@ export default function fetchWrapper(
104104
return getBuffer(response);
105105
})
106106

107-
.then(data => {
107+
.then((data) => {
108108
return {
109109
status,
110110
url,
111111
headers,
112-
data
112+
data,
113113
};
114114
})
115115

116-
.catch(error => {
116+
.catch((error) => {
117117
if (error instanceof RequestError) {
118118
throw error;
119119
}
120120

121121
throw new RequestError(error.message, 500, {
122122
headers,
123-
request: requestOptions
123+
request: requestOptions,
124124
});
125125
});
126126
}

src/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ import withDefaults from "./with-defaults";
66

77
export const request = withDefaults(endpoint, {
88
headers: {
9-
"user-agent": `octokit-request.js/${VERSION} ${getUserAgent()}`
10-
}
9+
"user-agent": `octokit-request.js/${VERSION} ${getUserAgent()}`,
10+
},
1111
});

src/with-defaults.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ import {
55
OctokitResponse,
66
Route,
77
RequestInterface,
8-
RequestParameters
8+
RequestParameters,
99
} from "@octokit/types";
1010

1111
export default function withDefaults(
1212
oldEndpoint: EndpointInterface,
1313
newDefaults: RequestParameters
1414
): RequestInterface {
1515
const endpoint = oldEndpoint.defaults(newDefaults);
16-
const newApi = function(
16+
const newApi = function (
1717
route: Route | EndpointOptions,
1818
parameters?: RequestParameters
1919
): Promise<OctokitResponse<any>> {
@@ -34,14 +34,14 @@ export default function withDefaults(
3434

3535
Object.assign(request, {
3636
endpoint,
37-
defaults: withDefaults.bind(null, endpoint)
37+
defaults: withDefaults.bind(null, endpoint),
3838
});
3939

4040
return endpointOptions.request.hook(request, endpointOptions);
4141
};
4242

4343
return Object.assign(newApi, {
4444
endpoint,
45-
defaults: withDefaults.bind(null, endpoint)
45+
defaults: withDefaults.bind(null, endpoint),
4646
});
4747
}

test/defaults.test.ts

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,25 @@ describe("endpoint.defaults()", () => {
1717
headers: {
1818
accept: "application/vnd.github.v3+json",
1919
authorization: "token 0000000000000000000000000000000000000001",
20-
"user-agent": "myApp/1.2.3"
21-
}
20+
"user-agent": "myApp/1.2.3",
21+
},
2222
}
2323
);
2424

2525
const myRequest = request.defaults({
2626
baseUrl: "https://github-enterprise.acme-inc.com/api/v3",
2727
headers: {
2828
"user-agent": "myApp/1.2.3",
29-
authorization: `token 0000000000000000000000000000000000000001`
29+
authorization: `token 0000000000000000000000000000000000000001`,
3030
},
3131
org: "my-project",
3232
per_page: 100,
3333
request: {
34-
fetch: mock
35-
}
34+
fetch: mock,
35+
},
3636
});
3737

38-
return myRequest(`GET /orgs/:org/repos`).then(response => {
38+
return myRequest(`GET /orgs/:org/repos`).then((response) => {
3939
expect(response.status).toEqual(200);
4040
});
4141
});
@@ -51,32 +51,32 @@ describe("endpoint.defaults()", () => {
5151
accept:
5252
"application/vnd.github.foo-preview.raw+json,application/vnd.github.bar-preview.raw+json",
5353
authorization: "token 0000000000000000000000000000000000000001",
54-
"user-agent": "myApp/1.2.3"
55-
}
54+
"user-agent": "myApp/1.2.3",
55+
},
5656
}
5757
);
5858

5959
const myProjectRequest = request.defaults({
6060
baseUrl: "https://github-enterprise.acme-inc.com/api/v3",
6161
headers: {
62-
"user-agent": "myApp/1.2.3"
62+
"user-agent": "myApp/1.2.3",
6363
},
6464
mediaType: {
6565
format: "raw+json",
66-
previews: ["foo", "bar"]
66+
previews: ["foo", "bar"],
6767
},
6868
org: "my-project",
6969
request: {
70-
fetch: mock
71-
}
70+
fetch: mock,
71+
},
7272
});
7373
const myProjectRequestWithAuth = myProjectRequest.defaults({
7474
headers: {
75-
authorization: `token 0000000000000000000000000000000000000001`
76-
}
75+
authorization: `token 0000000000000000000000000000000000000001`,
76+
},
7777
});
7878

79-
return myProjectRequestWithAuth(`GET /orgs/:org/repos`).then(response => {
79+
return myProjectRequestWithAuth(`GET /orgs/:org/repos`).then((response) => {
8080
expect(response.status).toEqual(200);
8181
});
8282
});

0 commit comments

Comments
 (0)