docs(new): migrate SecurityDetails docs to TSDoc (#6053)

This commit is contained in:
Mathias Bynens 2020-06-19 15:30:28 +02:00 committed by GitHub
parent 7a4170fe6e
commit 7978315de7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 52 additions and 31 deletions

View File

@ -22,7 +22,7 @@ snapshot(options?: SnapshotOptions): Promise<SerializedAXNode>;
Promise&lt;[SerializedAXNode](./puppeteer.serializedaxnode.md)<!-- -->&gt; Promise&lt;[SerializedAXNode](./puppeteer.serializedaxnode.md)<!-- -->&gt;
An AXNode object represeting the snapshot. An AXNode object representing the snapshot.
## Remarks ## Remarks

View File

@ -30,7 +30,7 @@
| [Mouse](./puppeteer.mouse.md) | | | [Mouse](./puppeteer.mouse.md) | |
| [Page](./puppeteer.page.md) | Page provides methods to interact with a single tab or \[extension background page\](https://developer.chrome.com/extensions/background\_pages) in Chromium. One \[Browser\] instance might have multiple \[Page\] instances. | | [Page](./puppeteer.page.md) | Page provides methods to interact with a single tab or \[extension background page\](https://developer.chrome.com/extensions/background\_pages) in Chromium. One \[Browser\] instance might have multiple \[Page\] instances. |
| [Puppeteer](./puppeteer.puppeteer.md) | The main Puppeteer class | | [Puppeteer](./puppeteer.puppeteer.md) | The main Puppeteer class |
| [SecurityDetails](./puppeteer.securitydetails.md) | | | [SecurityDetails](./puppeteer.securitydetails.md) | The SecurityDetails class represents the security details of a response that was received over a secure connection. |
| [Target](./puppeteer.target.md) | | | [Target](./puppeteer.target.md) | |
| [TimeoutError](./puppeteer.timeouterror.md) | | | [TimeoutError](./puppeteer.timeouterror.md) | |
| [Touchscreen](./puppeteer.touchscreen.md) | | | [Touchscreen](./puppeteer.touchscreen.md) | |

View File

@ -1,20 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [SecurityDetails](./puppeteer.securitydetails.md) &gt; [(constructor)](./puppeteer.securitydetails._constructor_.md)
## SecurityDetails.(constructor)
Constructs a new instance of the `SecurityDetails` class
<b>Signature:</b>
```typescript
constructor(securityPayload: Protocol.Network.SecurityDetails);
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| securityPayload | Protocol.Network.SecurityDetails | |

View File

@ -13,3 +13,5 @@ issuer(): string;
string string
The name of the issuer of the certificate.

View File

@ -4,17 +4,17 @@
## SecurityDetails class ## SecurityDetails class
The SecurityDetails class represents the security details of a response that was received over a secure connection.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
export declare class SecurityDetails export declare class SecurityDetails
``` ```
## Constructors ## Remarks
| Constructor | Modifiers | Description | The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SecurityDetails` class.
| --- | --- | --- |
| [(constructor)(securityPayload)](./puppeteer.securitydetails._constructor_.md) | | Constructs a new instance of the <code>SecurityDetails</code> class |
## Methods ## Methods

View File

@ -13,3 +13,5 @@ protocol(): string;
string string
The security protocol being used, e.g. "TLS 1.2".

View File

@ -13,3 +13,5 @@ subjectAlternativeNames(): string[];
string\[\] string\[\]
The list of [subject alternative names (SANs)](https://en.wikipedia.org/wiki/Subject_Alternative_Name) of the certificate.

View File

@ -13,3 +13,5 @@ subjectName(): string;
string string
The name of the subject to which the certificate was issued.

View File

@ -13,3 +13,5 @@ validFrom(): number;
number number
[Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) marking the start of the certificate's validity.

View File

@ -13,3 +13,5 @@ validTo(): number;
number number
[Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) marking the end of the certificate's validity.

View File

@ -173,7 +173,7 @@ export class Accessibility {
* } * }
* ``` * ```
* *
* @returns An AXNode object represeting the snapshot. * @returns An AXNode object representing the snapshot.
* *
*/ */
public async snapshot( public async snapshot(

View File

@ -16,6 +16,12 @@
import Protocol from '../protocol'; import Protocol from '../protocol';
/**
* The SecurityDetails class represents the security details of a
* response that was received over a secure connection.
*
* @public
*/
export class SecurityDetails { export class SecurityDetails {
private _subjectName: string; private _subjectName: string;
private _issuer: string; private _issuer: string;
@ -24,6 +30,9 @@ export class SecurityDetails {
private _protocol: string; private _protocol: string;
private _sanList: string[]; private _sanList: string[];
/**
* @internal
*/
constructor(securityPayload: Protocol.Network.SecurityDetails) { constructor(securityPayload: Protocol.Network.SecurityDetails) {
this._subjectName = securityPayload.subjectName; this._subjectName = securityPayload.subjectName;
this._issuer = securityPayload.issuer; this._issuer = securityPayload.issuer;
@ -33,26 +42,46 @@ export class SecurityDetails {
this._sanList = securityPayload.sanList; this._sanList = securityPayload.sanList;
} }
subjectName(): string { /**
return this._subjectName; * @returns The name of the issuer of the certificate.
} */
issuer(): string { issuer(): string {
return this._issuer; return this._issuer;
} }
/**
* @returns {@link https://en.wikipedia.org/wiki/Unix_time | Unix timestamp}
* marking the start of the certificate's validity.
*/
validFrom(): number { validFrom(): number {
return this._validFrom; return this._validFrom;
} }
/**
* @returns {@link https://en.wikipedia.org/wiki/Unix_time | Unix timestamp}
* marking the end of the certificate's validity.
*/
validTo(): number { validTo(): number {
return this._validTo; return this._validTo;
} }
/**
* @returns The security protocol being used, e.g. "TLS 1.2".
*/
protocol(): string { protocol(): string {
return this._protocol; return this._protocol;
} }
/**
* @returns The name of the subject to which the certificate was issued.
*/
subjectName(): string {
return this._subjectName;
}
/**
* @returns The list of {@link https://en.wikipedia.org/wiki/Subject_Alternative_Name | subject alternative names (SANs)} of the certificate.
*/
subjectAlternativeNames(): string[] { subjectAlternativeNames(): string[] {
return this._sanList; return this._sanList;
} }