Skip to content

Commit

Permalink
Fix warnings and un-ignore the docs folder
Browse files Browse the repository at this point in the history
  • Loading branch information
colincasey committed Apr 22, 2024
1 parent 20f629c commit b47e1a0
Show file tree
Hide file tree
Showing 60 changed files with 1,043 additions and 100 deletions.
36 changes: 0 additions & 36 deletions api/.gitignore

This file was deleted.

29 changes: 29 additions & 0 deletions api/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md)

## API Reference

## Packages

<table><thead><tr><th>

Package


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[tough-cookie](./tough-cookie.md)


</td><td>


</td></tr>
</tbody></table>
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.callback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [Callback](./tough-cookie.callback.md)

## Callback interface

A callback function that accepts an error or a result.

**Signature:**

```typescript
export interface Callback<T>
```
2 changes: 1 addition & 1 deletion api/docs/tough-cookie.canonicaldomain.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ domainName

</td><td>

Nullable&lt;string&gt;
[Nullable](./tough-cookie.nullable.md)<!-- -->&lt;string&gt;


</td><td>
Expand Down
2 changes: 1 addition & 1 deletion api/docs/tough-cookie.cookiecompare.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ NOTE: Not all user agents sort the cookie-list in this order, but this order ref

\#\#\# Custom Store Implementors

Since the JavaScript Date is limited to a 1-ms precision, cookies within the same millisecond are entirely possible. This is especially true when using the `now` option to . The [Cookie.creationIndex](./tough-cookie.cookie.creationindex.md) property is a per-process global counter, assigned during construction with `new Cookie()`<!-- -->, which preserves the spirit of the RFC sorting: older cookies go first. This works great for [MemoryCookieStore](./tough-cookie.memorycookiestore.md) since `Set-Cookie` headers are parsed in order, but is not so great for distributed systems.
Since the JavaScript Date is limited to a 1-ms precision, cookies within the same millisecond are entirely possible. This is especially true when using the `now` option to `CookieJar.setCookie(...)`<!-- -->. The [Cookie.creationIndex](./tough-cookie.cookie.creationindex.md) property is a per-process global counter, assigned during construction with `new Cookie()`<!-- -->, which preserves the spirit of the RFC sorting: older cookies go first. This works great for [MemoryCookieStore](./tough-cookie.memorycookiestore.md) since `Set-Cookie` headers are parsed in order, but is not so great for distributed systems.

Sophisticated Stores may wish to set this to some other logical clock so that if cookies `A` and `B` are created in the same millisecond, but cookie `A` is created before cookie `B`<!-- -->, then `A.creationIndex < B.creationIndex`<!-- -->.

Expand Down
2 changes: 1 addition & 1 deletion api/docs/tough-cookie.cookiejar._constructor_.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ store

</td><td>

Nullable&lt;[Store](./tough-cookie.store.md)<!-- -->&gt;
[Nullable](./tough-cookie.nullable.md)<!-- -->&lt;[Store](./tough-cookie.store.md)<!-- -->&gt;


</td><td>
Expand Down
15 changes: 15 additions & 0 deletions api/docs/tough-cookie.createcookieoptions.creation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [CreateCookieOptions](./tough-cookie.createcookieoptions.md) &gt; [creation](./tough-cookie.createcookieoptions.creation.md)

## CreateCookieOptions.creation property

Set to the date and time when a Cookie is initially stored or a matching cookie is received that replaces an existing cookie (See [RFC6265 Section 5.3](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.3)<!-- -->).

Also used to maintain ordering among cookies. Among cookies that have equal-length path fields, cookies with earlier creation-times are listed before cookies with later creation-times (See [RFC6265 Section 5.4](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.4)<!-- -->).

**Signature:**

```typescript
creation?: Date | 'Infinity' | null;
```
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.createcookieoptions.domain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [CreateCookieOptions](./tough-cookie.createcookieoptions.md) &gt; [domain](./tough-cookie.createcookieoptions.domain.md)

## CreateCookieOptions.domain property

The 'Domain' attribute of the cookie represents the domain the cookie belongs to (See [RFC6265 Section 5.2.3](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.2.3)<!-- -->).

**Signature:**

```typescript
domain?: string | null;
```
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.createcookieoptions.expires.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [CreateCookieOptions](./tough-cookie.createcookieoptions.md) &gt; [expires](./tough-cookie.createcookieoptions.expires.md)

## CreateCookieOptions.expires property

The 'Expires' attribute of the cookie (See [RFC6265 Section 5.2.1](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.2.1)<!-- -->).

**Signature:**

```typescript
expires?: Date | 'Infinity' | null;
```
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.createcookieoptions.extensions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [CreateCookieOptions](./tough-cookie.createcookieoptions.md) &gt; [extensions](./tough-cookie.createcookieoptions.extensions.md)

## CreateCookieOptions.extensions property

Contains attributes which are not part of the defined spec but match the `extension-av` syntax defined in Section 4.1.1 of RFC6265 (See [RFC6265 Section 4.1.1](https://www.rfc-editor.org/rfc/rfc6265.html#section-4.1.1)<!-- -->).

**Signature:**

```typescript
extensions?: string[] | null;
```
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.createcookieoptions.hostonly.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [CreateCookieOptions](./tough-cookie.createcookieoptions.md) &gt; [hostOnly](./tough-cookie.createcookieoptions.hostonly.md)

## CreateCookieOptions.hostOnly property

A boolean flag indicating if a cookie is a host-only cookie (i.e.; when the request's host exactly matches the domain of the cookie) or not (See [RFC6265 Section 5.3](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.3)<!-- -->).

**Signature:**

```typescript
hostOnly?: boolean | null;
```
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.createcookieoptions.httponly.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [CreateCookieOptions](./tough-cookie.createcookieoptions.md) &gt; [httpOnly](./tough-cookie.createcookieoptions.httponly.md)

## CreateCookieOptions.httpOnly property

The 'HttpOnly' flag of the cookie indicates if the cookie is inaccessible to client scripts or not (See [RFC6265 Section 5.2.6](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.2.6)<!-- -->).

**Signature:**

```typescript
httpOnly?: boolean;
```
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.createcookieoptions.key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [CreateCookieOptions](./tough-cookie.createcookieoptions.md) &gt; [key](./tough-cookie.createcookieoptions.key.md)

## CreateCookieOptions.key property

The name or key of the cookie

**Signature:**

```typescript
key?: string;
```
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.createcookieoptions.lastaccessed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [CreateCookieOptions](./tough-cookie.createcookieoptions.md) &gt; [lastAccessed](./tough-cookie.createcookieoptions.lastaccessed.md)

## CreateCookieOptions.lastAccessed property

Set to the date and time when a cookie was initially stored ([RFC6265 Section 5.3](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.3)<!-- -->) and updated whenever the cookie is retrieved from the [CookieJar](./tough-cookie.cookiejar.md) ([RFC6265 Section 5.4](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.4)<!-- -->).

**Signature:**

```typescript
lastAccessed?: Date | 'Infinity' | null;
```
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.createcookieoptions.maxage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [CreateCookieOptions](./tough-cookie.createcookieoptions.md) &gt; [maxAge](./tough-cookie.createcookieoptions.maxage.md)

## CreateCookieOptions.maxAge property

The 'Max-Age' attribute of the cookie (See [RFC6265 Section 5.2.2](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.2.2)<!-- -->).

**Signature:**

```typescript
maxAge?: number | 'Infinity' | '-Infinity' | null;
```
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.createcookieoptions.path.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [CreateCookieOptions](./tough-cookie.createcookieoptions.md) &gt; [path](./tough-cookie.createcookieoptions.path.md)

## CreateCookieOptions.path property

The 'Path' attribute of the cookie represents the path of the cookie (See [RFC6265 Section 5.2.4](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.2.4)<!-- -->).

**Signature:**

```typescript
path?: string | null;
```
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.createcookieoptions.pathisdefault.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [CreateCookieOptions](./tough-cookie.createcookieoptions.md) &gt; [pathIsDefault](./tough-cookie.createcookieoptions.pathisdefault.md)

## CreateCookieOptions.pathIsDefault property

A boolean flag indicating if a cookie had no 'Path' attribute and the default path was used (See [RFC6265 Section 5.2.4](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.2.4)<!-- -->).

**Signature:**

```typescript
pathIsDefault?: boolean | null;
```
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.createcookieoptions.samesite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [CreateCookieOptions](./tough-cookie.createcookieoptions.md) &gt; [sameSite](./tough-cookie.createcookieoptions.samesite.md)

## CreateCookieOptions.sameSite property

The 'SameSite' attribute of a cookie as defined in RFC6265bis (See [RFC6265bis (v13) Section 5.2](https://www.ietf.org/archive/id/draft-ietf-httpbis-rfc6265bis-13.html#section-5.2)<!-- -->).

**Signature:**

```typescript
sameSite?: string | undefined;
```
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.createcookieoptions.secure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [CreateCookieOptions](./tough-cookie.createcookieoptions.md) &gt; [secure](./tough-cookie.createcookieoptions.secure.md)

## CreateCookieOptions.secure property

The 'Secure' flag of the cookie indicates if the scope of the cookie is limited to secure channels (e.g.; HTTPS) or not (See [RFC6265 Section 5.2.5](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.2.5)<!-- -->).

**Signature:**

```typescript
secure?: boolean;
```
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.createcookieoptions.value.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [CreateCookieOptions](./tough-cookie.createcookieoptions.md) &gt; [value](./tough-cookie.createcookieoptions.value.md)

## CreateCookieOptions.value property

The value of the cookie

**Signature:**

```typescript
value?: string;
```
2 changes: 1 addition & 1 deletion api/docs/tough-cookie.defaultpath.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ path

</td><td>

Nullable&lt;string&gt;
[Nullable](./tough-cookie.nullable.md)<!-- -->&lt;string&gt;


</td><td>
Expand Down
4 changes: 2 additions & 2 deletions api/docs/tough-cookie.domainmatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ domain

</td><td>

Nullable&lt;string&gt;
[Nullable](./tough-cookie.nullable.md)<!-- -->&lt;string&gt;


</td><td>
Expand All @@ -53,7 +53,7 @@ cookieDomain

</td><td>

Nullable&lt;string&gt;
[Nullable](./tough-cookie.nullable.md)<!-- -->&lt;string&gt;


</td><td>
Expand Down
13 changes: 13 additions & 0 deletions api/docs/tough-cookie.errorcallback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [tough-cookie](./tough-cookie.md) &gt; [ErrorCallback](./tough-cookie.errorcallback.md)

## ErrorCallback interface

A callback function that only accepts an error.

**Signature:**

```typescript
export interface ErrorCallback
```
Loading

0 comments on commit b47e1a0

Please sign in to comment.