Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from Jun 19, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion new-docs/puppeteer.accessibility.snapshot.md
Expand Up @@ -22,7 +22,7 @@ snapshot(options?: SnapshotOptions): Promise<SerializedAXNode>;

Promise&lt;[SerializedAXNode](./puppeteer.serializedaxnode.md)<!-- -->&gt;

An AXNode object represeting the snapshot.
An AXNode object representing the snapshot.

## Remarks

Expand Down
2 changes: 1 addition & 1 deletion new-docs/puppeteer.md
Expand Up @@ -30,7 +30,7 @@
| [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. |
| [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) | |
| [TimeoutError](./puppeteer.timeouterror.md) | |
| [Touchscreen](./puppeteer.touchscreen.md) | |
Expand Down
20 changes: 0 additions & 20 deletions new-docs/puppeteer.securitydetails._constructor_.md

This file was deleted.

2 changes: 2 additions & 0 deletions new-docs/puppeteer.securitydetails.issuer.md
Expand Up @@ -13,3 +13,5 @@ issuer(): string;

string

The name of the issuer of the certificate.

8 changes: 4 additions & 4 deletions new-docs/puppeteer.securitydetails.md
Expand Up @@ -4,17 +4,17 @@

## SecurityDetails class

The SecurityDetails class represents the security details of a response that was received over a secure connection.

<b>Signature:</b>

```typescript
export declare class SecurityDetails
```

## Constructors
## Remarks

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(securityPayload)](./puppeteer.securitydetails._constructor_.md) | | Constructs a new instance of the <code>SecurityDetails</code> class |
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.

## Methods

Expand Down
2 changes: 2 additions & 0 deletions new-docs/puppeteer.securitydetails.protocol.md
Expand Up @@ -13,3 +13,5 @@ protocol(): string;

string

The security protocol being used, e.g. "TLS 1.2".

2 changes: 2 additions & 0 deletions new-docs/puppeteer.securitydetails.subjectalternativenames.md
Expand Up @@ -13,3 +13,5 @@ subjectAlternativeNames(): string[];

string\[\]

The list of [subject alternative names (SANs)](https://en.wikipedia.org/wiki/Subject_Alternative_Name) of the certificate.

2 changes: 2 additions & 0 deletions new-docs/puppeteer.securitydetails.subjectname.md
Expand Up @@ -13,3 +13,5 @@ subjectName(): string;

string

The name of the subject to which the certificate was issued.

2 changes: 2 additions & 0 deletions new-docs/puppeteer.securitydetails.validfrom.md
Expand Up @@ -13,3 +13,5 @@ validFrom(): number;

number

[Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) marking the start of the certificate's validity.

2 changes: 2 additions & 0 deletions new-docs/puppeteer.securitydetails.validto.md
Expand Up @@ -13,3 +13,5 @@ validTo(): number;

number

[Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) marking the end of the certificate's validity.

2 changes: 1 addition & 1 deletion src/common/Accessibility.ts
Expand Up @@ -173,7 +173,7 @@ export class Accessibility {
* }
* ```
*
* @returns An AXNode object represeting the snapshot.
* @returns An AXNode object representing the snapshot.
*
*/
public async snapshot(
Expand Down
37 changes: 33 additions & 4 deletions src/common/SecurityDetails.ts
Expand Up @@ -16,6 +16,12 @@

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 {
private _subjectName: string;
private _issuer: string;
Expand All @@ -24,6 +30,9 @@ export class SecurityDetails {
private _protocol: string;
private _sanList: string[];

/**
* @internal
*/
constructor(securityPayload: Protocol.Network.SecurityDetails) {
this._subjectName = securityPayload.subjectName;
this._issuer = securityPayload.issuer;
Expand All @@ -33,26 +42,46 @@ export class SecurityDetails {
this._sanList = securityPayload.sanList;
}

subjectName(): string {
return this._subjectName;
}

/**
* @returns The name of the issuer of the certificate.
*/
issuer(): string {
return this._issuer;
}

/**
* @returns {@link https://en.wikipedia.org/wiki/Unix_time | Unix timestamp}
* marking the start of the certificate's validity.
*/
validFrom(): number {
return this._validFrom;
}

/**
* @returns {@link https://en.wikipedia.org/wiki/Unix_time | Unix timestamp}
* marking the end of the certificate's validity.
*/
validTo(): number {
return this._validTo;
}

/**
* @returns The security protocol being used, e.g. "TLS 1.2".
*/
protocol(): string {
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[] {
return this._sanList;
}
Expand Down