summaryrefslogtreecommitdiffstats
path: root/remote/test/puppeteer/packages/puppeteer-core/src/api/HTTPResponse.ts
blob: ddc56279a4701ad32ba3e11dd4f0fe24daddb95b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/**
 * Copyright 2023 Google Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import Protocol from 'devtools-protocol';

import {Frame} from '../common/Frame.js';
import {SecurityDetails} from '../common/SecurityDetails.js';

import {HTTPRequest} from './HTTPRequest.js';

/**
 * @public
 */
export interface RemoteAddress {
  ip?: string;
  port?: number;
}

/**
 * The HTTPResponse class represents responses which are received by the
 * {@link Page} class.
 *
 * @public
 */
export class HTTPResponse {
  /**
   * @internal
   */
  constructor() {}

  /**
   * @internal
   */
  _resolveBody(_err: Error | null): void {
    throw new Error('Not implemented');
  }

  /**
   * The IP address and port number used to connect to the remote
   * server.
   */
  remoteAddress(): RemoteAddress {
    throw new Error('Not implemented');
  }

  /**
   * The URL of the response.
   */
  url(): string {
    throw new Error('Not implemented');
  }

  /**
   * True if the response was successful (status in the range 200-299).
   */
  ok(): boolean {
    throw new Error('Not implemented');
  }

  /**
   * The status code of the response (e.g., 200 for a success).
   */
  status(): number {
    throw new Error('Not implemented');
  }

  /**
   * The status text of the response (e.g. usually an "OK" for a
   * success).
   */
  statusText(): string {
    throw new Error('Not implemented');
  }

  /**
   * An object with HTTP headers associated with the response. All
   * header names are lower-case.
   */
  headers(): Record<string, string> {
    throw new Error('Not implemented');
  }

  /**
   * {@link SecurityDetails} if the response was received over the
   * secure connection, or `null` otherwise.
   */
  securityDetails(): SecurityDetails | null {
    throw new Error('Not implemented');
  }

  /**
   * Timing information related to the response.
   */
  timing(): Protocol.Network.ResourceTiming | null {
    throw new Error('Not implemented');
  }

  /**
   * Promise which resolves to a buffer with response body.
   */
  buffer(): Promise<Buffer> {
    throw new Error('Not implemented');
  }

  /**
   * Promise which resolves to a text representation of response body.
   */
  async text(): Promise<string> {
    const content = await this.buffer();
    return content.toString('utf8');
  }

  /**
   * Promise which resolves to a JSON representation of response body.
   *
   * @remarks
   *
   * This method will throw if the response body is not parsable via
   * `JSON.parse`.
   */
  async json(): Promise<any> {
    const content = await this.text();
    return JSON.parse(content);
  }

  /**
   * A matching {@link HTTPRequest} object.
   */
  request(): HTTPRequest {
    throw new Error('Not implemented');
  }

  /**
   * True if the response was served from either the browser's disk
   * cache or memory cache.
   */
  fromCache(): boolean {
    throw new Error('Not implemented');
  }

  /**
   * True if the response was served by a service worker.
   */
  fromServiceWorker(): boolean {
    throw new Error('Not implemented');
  }

  /**
   * A {@link Frame} that initiated this response, or `null` if
   * navigating to error pages.
   */
  frame(): Frame | null {
    throw new Error('Not implemented');
  }
}