Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

fix(docs): APIRequest* variable names (#9621)

Browse source
This commit is contained in:
Yury Semikhatsky 2021-10-19 09:37:17 -07:00 committed by GitHub
parent 53c866c0f2
commit ade2171c4b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
packages/playwright-core/types/types.d.ts vendored
View file

@ -11604,7 +11604,7 @@ export interface APIRequest {
newContext(options?: {
/**
* Methods like
* [aPIRequestContext.get(url[, options])](https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-get)
* [apiRequestContext.get(url[, options])](https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-get)
* take the base URL into consideration by using the [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL)
* constructor for building the corresponding URL. Examples:
* - baseURL: `http://localhost:3000` and sending request to `/bar.html` results in `http://localhost:3000/bar.html`
@ -11663,11 +11663,11 @@ export interface APIRequest {
* obtained via
* [browserContext.storageState([options])](https://playwright.dev/docs/api/class-browsercontext#browser-context-storage-state)
* or
* [aPIRequestContext.storageState([options])](https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-storage-state).
* [apiRequestContext.storageState([options])](https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-storage-state).
* Either a path to the file with saved storage, or the value returned by one of
* [browserContext.storageState([options])](https://playwright.dev/docs/api/class-browsercontext#browser-context-storage-state)
* or
* [aPIRequestContext.storageState([options])](https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-storage-state)
* [apiRequestContext.storageState([options])](https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-storage-state)
* methods.
*/
storageState?: string|{
@ -11758,7 +11758,7 @@ export interface APIRequestContext {
/**
* All responses returned by
* [aPIRequestContext.get(url[, options])](https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-get)
* [apiRequestContext.get(url[, options])](https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-get)
* and similar methods are stored in the memory, so that you can later call
* [apiResponse.body()](https://playwright.dev/docs/api/class-apiresponse#api-response-body). This method discards all
* stored responses, and makes [apiResponse.body()](https://playwright.dev/docs/api/class-apiresponse#api-response-body)
@ -12170,7 +12170,7 @@ export interface APIRequestContext {
/**
* [ApiResponse] class represents responses returned by
* [aPIRequestContext.get(url[, options])](https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-get)
* [apiRequestContext.get(url[, options])](https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-get)
* and similar methods.
*/
export interface ApiResponse {

2
utils/doclint/documentation.js
View file

@ -167,7 +167,7 @@ Documentation.Class = class {
this.extends = extendsName;
this.comment = '';
this.index();
const match = name.match(/(JS|CDP|[A-Z])(.*)/);
const match = name.match(/(API|JS|CDP|[A-Z])(.*)/);
this.varName = match[1].toLowerCase() + match[2];
}