JSR

https://jsr.io/*/doc
Admin
JSR is an open-source package registry for modern JavaScript and TypeScript, providing a streamlined...
Tokens:11,814
Snippets:155
Trust Score:9.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Dependencies

Source: https://jsr.io/@eldt/docs

Use this command to install the necessary dependencies for the project.

```bash
bun install

```

--------------------------------

### Install @deno/doc Package

Source: https://jsr.io/@deno/doc

Use the deno add command to install the @deno/doc package.

```bash
deno add jsr:@deno/doc

```

--------------------------------

### Install doci CLI for Development

Source: https://jsr.io/@cloudydeno/doci

Installs the doci CLI for development purposes, using a local deno.json configuration.

```bash
deno install -f --global --allow-read --allow-write=$HOME,/tmp --allow-run --allow-net --allow-env --config deno.json doci/mod.ts
```

--------------------------------

### Add Cloudydeno Docker Registry Client Package

Source: https://jsr.io/@cloudydeno/docker-registry-client

Install the package using the Deno add command.

```bash
deno add jsr:@cloudydeno/docker-registry-client
```

--------------------------------

### Install Latest doci CLI from Git

Source: https://jsr.io/@cloudydeno/doci

Installs the latest version of the doci CLI directly from its GitHub repository.

```bash
deno install -f --global --allow-read --allow-write=$HOME,${TMPDIR:-/tmp} --allow-run --allow-net --allow-env --reload=https://raw.githubusercontent.com https://raw.githubusercontent.com/cloudydeno/denodir-oci/main/doci/mod.ts
```

--------------------------------

### Install Released Version of doci CLI

Source: https://jsr.io/@cloudydeno/doci

Installs the globally released version of the doci CLI with necessary permissions.

```bash
deno install -f --global --allow-read --allow-write=$HOME,${TMPDIR:-/tmp} --allow-run --allow-net --allow-env jsr:@cloudydeno/doci/cli
```

--------------------------------

### Generate and Print Module Documentation

Source: https://jsr.io/@deno/doc

A minimal example demonstrating how to use the doc() function to retrieve and print information about a module's functions. This requires network and read permissions.

```typescript
import { doc } from "@deno/doc";

const records = await doc(["https://deno.land/std/fmt/colors.ts"]);
const colorsDoc = records["https://deno.land/std/fmt/colors.ts"];

for (const node of colorsDoc) {
  console.log(`name: ${node.name} kind: ${node.kind}`);
}

```

--------------------------------

### Docsy Element Examples

Source: https://jsr.io/@dldc/docsy

Provides a comprehensive set of examples for various Docsy element types and their variations.

```Docsy Syntax
// Normal: open / close
<|Tag>Some content<Tag/>
```

```Docsy Syntax
// Normal: open / close shortcut
<|Tag>Some content</>
```

```Docsy Syntax
// Raw: open / close
<#Tag>Some content<Tag/>
```

```Docsy Syntax
// Raw: open / close shortcut
<#Tag>Some content</>
```

```Docsy Syntax
// Normal: line
<Tag>Hello Test

```

```Docsy Syntax
// Self closig
</Tag/>
```

```Docsy Syntax
// FRAGMENTS

// Normal fragment
<|>Some content</>
```

```Docsy Syntax
// Raw fragment
<#>Some content</>
```

--------------------------------

### Import Docsy Package (Alias)

Source: https://jsr.io/@dldc/docsy

Example of importing the Docsy package using an alias in JavaScript/TypeScript.

```JavaScript
import * as docsy from "@dldc/docsy";

```

--------------------------------

### Import Docsy Package (JSR Specifier)

Source: https://jsr.io/@dldc/docsy

Example of importing the Docsy package directly using its JSR specifier in JavaScript/TypeScript.

```JavaScript
import * as docsy from "jsr:@dldc/docsy";

```

--------------------------------

### Extract Specific Pages from DOCX to PDF

Source: https://jsr.io/@baiq/document-parser

Converts a DOCX file to a PDF containing only the specified pages, using the `soffice` CLI. Requires LibreOffice to be installed and in the system's PATH.

```typescript
import { extractPagesFromDOCX } from "@baiq/document-parser";
const outPath = await extractPagesFromDOCX("file.docx", [1, 3]);
console.log(outPath);
```

--------------------------------

### Initialize and Use DocumentCloud Client

Source: https://jsr.io/@alex-garcia/documentcloud-ts

Demonstrates how to initialize the DocumentCloud client with and without authentication, and how to perform common operations like listing, searching, and creating documents.

```typescript
import { DocumentCloud } from "documentcloud";

// Anonymous access
const client = new DocumentCloud();

// Authenticated access
const client = new DocumentCloud({
  username: "user@example.com",
  password: "password",
});

// List documents
for await (const doc of client.documents.list()) {
  console.log(doc.title);
}

// Search documents
const results = await client.documents.search("climate change").all();

// Create a document from URL
const doc = await client.documents.create({
  title: "My Document",
  file_url: "https://example.com/document.pdf",
});

```

--------------------------------

### Build OCI Artifact with Dependencies and Entrypoint (Condensed)

Source: https://jsr.io/@cloudydeno/doci

Builds an OCI artifact including dependency files and the main entrypoint, using condensed syntax for multiple files.

```bash
# A deps.ts for dependencies, followed by the actual entrypoint
doci build \
  https://raw.githubusercontent.com/cloudydeno/kubernetes-dns-sync/main/src/deps.ts
  https://raw.githubusercontent.com/cloudydeno/kubernetes-dns-sync/main/src/controller/mod.ts

# or, condensed:
doci build https://raw.githubusercontent.com/cloudydeno/kubernetes-dns-sync/main/src/{deps,controller/mod}.ts
```

--------------------------------

### Run Project

Source: https://jsr.io/@eldt/docs

Execute the project's main script using this command.

```bash
bun run index.ts

```

--------------------------------

### Add JSR Package

Source: https://jsr.io/@devmode/docs-example

Command to add the @devmode/docs-example package to your Deno project.

```bash
deno add jsr:@devmode/docs-example
```

--------------------------------

### Add @babia-test/docs Package

Source: https://jsr.io/@babia-test/docs

Use this command to add the package to your Deno project.

```bash
deno add jsr:@babia-test/docs

```

--------------------------------

### Fragment Syntax

Source: https://jsr.io/@dldc/docsy

Demonstrates the syntax for creating normal and raw fragments.

```Docsy Syntax
<|>Content</>
```

```Docsy Syntax
<#>Content</>
```

--------------------------------

### Add Elysium Docs Package with Deno

Source: https://jsr.io/@elysium/docs

Add the @elysium/docs package to your Deno project using the deno add command.

```bash
deno add jsr:@elysium/docs

```

--------------------------------

### Recommended Interface Documentation Approach

Source: https://jsr.io/@devmode/docs-example

This snippet shows the recommended way to document interfaces using inline comments for properties and JSDoc for the interface itself, enhancing IDE readability.

```typescript
// ===== Interfaces ===== //

/**
 * Description
 *
 * Provide useful details for the IDE:
 * - The IDE does not provide details about the
 *   interface's properties
 */
interface Type1 {
  /** Description for 'a' */
  a: string;

  /** Description for 'b' */
  b: number;

  /** Description for 'c' */
  c?: {
    /** Description for 'd' */
    d: boolean;
  };
}
```

--------------------------------

### Recommended Type Documentation Approach

Source: https://jsr.io/@devmode/docs-example

This snippet illustrates the recommended method for documenting types using inline comments for properties and JSDoc for the type definition, improving IDE clarity.

```typescript
// ===== Types ===== //

/**
 * Description
 *
 * Provide useful details for the IDE
 */
type Type2 = {
  /** Description for 'a' */
  a: string;

  /** Description for 'b' */
  b: number;

  /** Description for 'c' */
  c?: {
    /** Description for 'd' */
    d: boolean;
  };
};
```

--------------------------------

### Build OCI Artifact with Multiple Layers (Condensed)

Source: https://jsr.io/@cloudydeno/doci

Builds an OCI artifact using multiple layers, with dependencies specified concisely using brace expansion.

```bash
# One big static module and one smaller module which changes often
doci build \
  https://raw.githubusercontent.com/cloudydeno/notion-toolbox/main/object-model/mod.ts \
  https://raw.githubusercontent.com/cloudydeno/notion-toolbox/main/publish-firebase-blog/mod.ts

# or, condensed:
doci build https://raw.githubusercontent.com/cloudydeno/notion-toolbox/main/{object-model,publish-firebase-blog}/mod.ts
```

--------------------------------

### Add Package using deno add

Source: https://jsr.io/@cloudydeno/doci

Use this command to add the @cloudydeno/doci package to your Deno project.

```bash
deno add jsr:@cloudydeno/doci

```

--------------------------------

### RegistryClientOpts Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Options for configuring the Docker Registry Client.

```APIDOC
## RegistryClientOpts Interface

### Description
Configuration options for initializing the Docker Registry Client.

### Fields
- `name`: (string) - The name of the registry.
- `scheme`: ("https" | "http") - The protocol scheme to use.
- `insecure`: (boolean) - Whether to allow insecure connections.
- `client`: (Deno.HttpClient) - A custom Deno HTTP client.
- `repo`: (RegistryRepo) - Repository configuration.
- `scopes`: (string[]) - Array of scopes for authentication.
- `username`: (string) - Username for authentication.
- `password`: (string) - Password for authentication.
- `token`: (string) - Bearer token for authentication.
- `acceptManifestLists`: (boolean) - Whether to accept manifest lists.
- `acceptOCIManifests`: (boolean) - Whether to accept OCI manifests.
- `userAgent`: (string) - Custom User-Agent string.
```

--------------------------------

### Import All Symbols from @deno/doc

Source: https://jsr.io/@deno/doc

Import all symbols from the @deno/doc package using a namespace import.

```typescript
import * as doc from "@deno/doc";

```

--------------------------------

### Recommended Function Documentation Approach

Source: https://jsr.io/@devmode/docs-example

This snippet demonstrates the recommended approach for documenting functions using a combination of JSDoc and inline comments for better IDE and JSR.io compatibility.

```typescript
// ===== Functions ===== //

/**
 * Description
 *
 * For IDE, document well so you don't have to rely on reading JSDoc tags
 *
 * @param param1 - Description
 * @param param2 - Description
 * @param param3 - Description
 *   See Type3 for more details
 */
function someFn(param1: boolean, param2: string, param3: Type3): void {}
```

--------------------------------

### Import Docker Registry Client Package

Source: https://jsr.io/@cloudydeno/docker-registry-client

Import the package using a namespace import.

```typescript
import * as docker_registry_client from "@cloudydeno/docker-registry-client";
```

--------------------------------

### Import DocumentCloud TypeScript Package (Deno)

Source: https://jsr.io/@alex-garcia/documentcloud-ts

Import the DocumentCloud TypeScript package using a namespace import.

```typescript
import * as documentcloud_ts from "@alex-garcia/documentcloud-ts";

```

--------------------------------

### Add @baiq/document-parser to Deno Project

Source: https://jsr.io/@baiq/document-parser

Command to add the @baiq/document-parser package to your Deno project using the JSR package manager.

```bash
deno add jsr:@baiq/document-parser
```

--------------------------------

### Build OCI Artifact for Multiple Files

Source: https://jsr.io/@cloudydeno/doci

Builds a Deno cache directory OCI artifact from multiple TypeScript files.

```bash
doci build https://deno.land/std@0.177.0/examples/colors.ts # Two files
```

```bash
doci build https://deno.land/std@0.177.0/examples/flags.ts # Three files
```

--------------------------------

### Injecting Values with Braces

Source: https://jsr.io/@dldc/docsy

Demonstrates how to inject dynamic values into text using curly braces.

```Docsy Syntax
Two plus two is {2 + 2} !
```

--------------------------------

### Add JSR Package

Source: https://jsr.io/@eldt/docs

Add the @eldt/docs package to your Deno project using the deno add command.

```bash
deno add jsr:@eldt/docs

```

--------------------------------

### parseRepo

Source: https://jsr.io/@cloudydeno/docker-registry-client

Parse a docker repo and tag string.

```APIDOC
## Function: parseRepo

### Description
Parses a Docker repository and tag string into a structured object. The format is `[INDEX/]REPO[:TAG|@DIGEST]`.

### Signature
`parseRepo(arg: string, defaultIndex?: string | RegistryIndex): RegistryRepo`
```

--------------------------------

### Build OCI Artifact for a Single File

Source: https://jsr.io/@cloudydeno/doci

Builds a Deno cache directory OCI artifact from a single TypeScript file.

```bash
doci build https://deno.land/std@0.177.0/examples/welcome.ts # A single file
```

--------------------------------

### DockerResponse

Source: https://jsr.io/@cloudydeno/docker-registry-client

Represents a response from the Docker registry API.

```APIDOC
## DockerResponse

### Description
Represents a response from the Docker registry API.

### Properties
- **decodedBody**: ByteArray

### Methods
- **dockerBody(): Promise<ByteArray>**
  Gets the raw response body as a byte array.
- **dockerErrors(): Promise<Array<{ code?: string; message: string; detail?: string; }>>**
  Parses and returns any errors from the response.
- **dockerJson<Tjson = Record<string, unknown>>(): Promise<Tjson>**
  Parses the response body as JSON.
- **dockerStream(): ReadableStream<ByteArray>**
  Returns the response body as a readable stream of byte arrays.
- **dockerThrowable(baseMsg: string): Promise<HttpError>**
  Throws an HttpError based on the response and provided message.
```

--------------------------------

### doc() function

Source: https://jsr.io/@deno/doc

The `doc()` function takes an array of string URL module specifiers and options, and returns a record of documentation nodes keyed by module URL. These nodes represent the surface API of the module.

```APIDOC
## `doc()`

### Description
The `doc()` function takes an array of string URL module specifiers and potentially some options, and asynchronously resolves with a record of documentation nodes keyed by the module URL, which represent the surface API of the module.

### Method
`async function doc(moduleSpecifiers: string[], options?: object): Promise<Record<string, DocNode[]>>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```typescript
import { doc } from "@deno/doc";

const records = await doc(["https://deno.land/std/fmt/colors.ts"]);
const colorsDoc = records["https://deno.land/std/fmt/colors.ts"];

for (const node of colorsDoc) {
  console.log(`name: ${node.name} kind: ${node.kind}`);
}
```

### Response
#### Success Response (200)
- **records** (Record<string, DocNode[]>) - A record where keys are module URLs and values are arrays of `DocNode` objects representing the module's surface API.

#### Response Example
```json
{
  "https://deno.land/std/fmt/colors.ts": [
    {
      "name": "red",
      "kind": "function",
      "docs": {
        "text": "Red text.",
        "kind": "plainText"
      },
      "params": [
        {
          "name": "s",
          "type": {
            "kind": "keyword",
            "name": "string"
          }
        }
      ],
      "returnType": {
        "kind": "keyword",
        "name": "string"
      }
    }
  ]
}
```
```

--------------------------------

### Import Package

Source: https://jsr.io/@devmode/docs-example

Import the package using a namespace import.

```typescript
import * as docs_example from "@devmode/docs-example";
```

--------------------------------

### Import DocumentCloud TypeScript Package Directly (Deno)

Source: https://jsr.io/@alex-garcia/documentcloud-ts

Import the DocumentCloud TypeScript package directly using a JSR specifier.

```typescript
import * as documentcloud_ts from "jsr:@alex-garcia/documentcloud-ts";

```

--------------------------------

### RegistryClientV2

Source: https://jsr.io/@cloudydeno/docker-registry-client

Client for interacting with Docker Registry API V2.

```APIDOC
## Class: RegistryClientV2

### Description
Provides methods to interact with a Docker Registry API V2.

### Constructor
`RegistryClientV2(opts: RegistryClientOpts)`

### Methods

#### `_getToken(opts: { realm: string; service?: string; scopes?: string[]; }): Promise<string>`
Get an auth token.

#### `_headOrGetBlob(method: "GET" | "HEAD", digest: string): Promise<DockerResponse[]>`
No documentation available.

#### `_makeHttpRequest(opts: { method: string; path: string; headers?: Headers; followRedirects?: boolean; maxRedirects?: number; }): Promise<DockerResponse[]>`
Makes a http request to the given url, following any redirects, then fires the callback(err, req, responses) with the result.

#### `blobUpload(opts: { digest: string; stream: ReadableStream<ByteArray> | ByteArray; contentLength: number; contentType?: string; }): Promise<void>`
No documentation available.

#### `createBlobReadStream(opts: { digest: string; }): Promise<{ ress: DockerResponse[]; stream: ReadableStream<ByteArray>; }>`
Get a ReadableStream to the given blob. https://docs.docker.com/registry/spec/api/#get-blob

#### `deleteManifest(opts: { ref: string; }): Promise<void>`
No documentation available.

#### `getManifest(opts: { ref: string; acceptManifestLists?: boolean; acceptOCIManifests?: boolean; followRedirects?: boolean; }): Promise<{ resp: DockerResponse; manifest: Manifest; }>`
No documentation available.

#### `headBlob(opts: { digest: string; }): Promise<DockerResponse[]>`
No documentation available.

#### `listAllTags(props?: { pageSize?: number; }): Promise<TagList>`
No documentation available.

#### `listTags(props?: { pageSize?: number; startingAfter?: string; }): Promise<TagList>`
No documentation available.

#### `listTagsPaginated(props?: { pageSize?: number; }): AsyncGenerator<TagList>`
No documentation available.

#### `login(opts?: { pingRes?: DockerResponse; scope?: string; }): Promise<void>`
Get a registry session (i.e. login to the registry).

#### `performLogin(opts: { scope?: string; pingRes?: DockerResponse; }): Promise<AuthInfo>`
Login V2

#### `ping(opts?: { headers?: Headers; expectStatus?: number[]; }): Promise<DockerResponse>`
Ping the base URL. See: https://docs.docker.com/registry/spec/api/#base

#### `putManifest(opts: { manifestData: ByteArray; ref: string; schemaVersion?: number; mediaType?: string; }): Promise<{ digest: string | null; location: string | null; }>`
No documentation available.

#### `supportsV2(): Promise<boolean>`
Determine if this registry supports the v2 API. https://docs.docker.com/registry/spec/api/#api-version-check
```

--------------------------------

### ManifestOCI Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Represents an OCI image manifest.

```APIDOC
## ManifestOCI Interface

### Description
Represents an OCI image manifest, including annotations, configuration descriptor, and layers.

### Fields
- `mediaType`: (string) - Must be "application/vnd.oci.image.manifest.v1+json".
- `schemaVersion`: (number) - Must be 2.
- `config`: (ManifestOCIDescriptor) - Descriptor for the image configuration.
- `layers`: (Array<ManifestOCIDescriptor>) - Array of descriptors for the image layers.
- `annotations`: (Record<string, string>) - Optional annotations for the manifest.
```

--------------------------------

### Import test_doc from @babia-test/docs

Source: https://jsr.io/@babia-test/docs

Import the test_doc function from the package using its scoped name.

```typescript
import { test_doc } from "@babia-test/docs";

```

--------------------------------

### Close Tag Shortcut

Source: https://jsr.io/@dldc/docsy

Demonstrates the shorthand for closing tags in both normal and raw elements.

```Docsy Syntax
<|Tag>Content</>
```

```Docsy Syntax
<#Tag>Content</>
```

--------------------------------

### Import Document Parser Module with Alias

Source: https://jsr.io/@baiq/document-parser

Import the document parser module and assign it an alias for use within your Deno project.

```typescript
import * as document_parser from "@baiq/document-parser";
```

--------------------------------

### Add DocumentCloud TypeScript Package to Deno

Source: https://jsr.io/@alex-garcia/documentcloud-ts

Use this command to add the DocumentCloud TypeScript package to your Deno project.

```bash
deno add jsr:@alex-garcia/documentcloud-ts

```

--------------------------------

### ManifestV2List Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Represents a Docker V2 manifest list.

```APIDOC
## ManifestV2List Interface

### Description
Represents a Docker V2 manifest list, which is a list of manifests for different platforms.

### Fields
- `mediaType`: (string) - Must be "application/vnd.docker.distribution.manifest.list.v2+json".
- `schemaVersion`: (number) - Must be 2.
- `manifests`: (Array<object>) - An array of manifest descriptors, each including media type, digest, size, and platform information.

```

--------------------------------

### Basic Element Syntax

Source: https://jsr.io/@dldc/docsy

Illustrates the basic structure of opening and closing elements in Docsy.

```Docsy Syntax
<|Tag>Content<Tag/>
```

--------------------------------

### ManifestV2 Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Represents a Docker V2 image manifest.

```APIDOC
## ManifestV2 Interface

### Description
Represents a Docker image manifest in version 2 format.

### Fields
- `mediaType`: (string) - Must be "application/vnd.docker.distribution.manifest.v2+json".
- `schemaVersion`: (number) - Must be 2.
- `config`: (ManifestV2Descriptor) - Descriptor for the image configuration.
- `layers`: (Array<ManifestV2Descriptor>) - Array of descriptors for the image layers.
```

--------------------------------

### Raw Element Syntax

Source: https://jsr.io/@dldc/docsy

Shows the syntax for raw elements, where content is treated strictly as text.

```Docsy Syntax
<#Tag>Content<Tag/>
```

--------------------------------

### parseRepo

Source: https://jsr.io/@cloudydeno/docker-registry-client

Parses a docker repository and tag string into a structured RegistryRepo object. Supports formats like `[INDEX/]REPO[:TAG]`.

```APIDOC
## parseRepo

### Description
Parse a docker repo and tag string: [INDEX/]REPO[:TAG|@DIGEST]

### Signature
parseRepo(
arg: string,
defaultIndex?: string | RegistryIndex
): RegistryRepo
```

--------------------------------

### TagList Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Represents a list of tags for an image in the Docker registry.

```APIDOC
## TagList

### Description
Represents a list of tags for an image in the Docker registry.

### Properties

- **name** (string) - The name of the image.
- **tags** (Array<string>) - An array of tag names.
- **child** (Array<string>) - An array of child references.
- **manifest** (Record<string, object>) - A map of manifest details, including `imageSizeBytes`, `layerId`, `mediaType`, `tag`, `timeCreatedMs`, and `timeUploadedMs`.
```

--------------------------------

### Build OCI Artifact for a Large Image

Source: https://jsr.io/@cloudydeno/doci

Builds a Deno cache directory OCI artifact from a potentially large or complex TypeScript file.

```bash
doci build https://raw.githubusercontent.com/cloudydeno/kubernetes-dns-sync/main/src/controller/mod.ts
```

--------------------------------

### RegistryClientV2

Source: https://jsr.io/@cloudydeno/docker-registry-client

Represents a client for interacting with a Docker Registry API, specifically version 2.

```APIDOC
## Class: RegistryClientV2

### Description

Provides methods to interact with a Docker Registry API (v2).

### Methods

#### `_getToken(opts: { realm: string; service?: string; scopes?: string[]; }): Promise<string>`

**Description**: Retrieves an authentication token from the registry.

#### `_headOrGetBlob(method: "GET" | "HEAD", digest: string): Promise<DockerResponse[]>`

**Description**: Performs a HEAD or GET request for a specific blob identified by its digest.

#### `_makeHttpRequest(opts: { method: string; path: string; headers?: Headers; followRedirects?: boolean; maxRedirects?: number; }): Promise<DockerResponse[]>`

**Description**: Makes a generic HTTP request to the registry, handling redirects.

#### `blobUpload(opts: { digest: string; stream: ReadableStream<ByteArray> | ByteArray; contentLength: number; contentType?: string; }): Promise<void>`

**Description**: Uploads a blob to the registry.

#### `createBlobReadStream(opts: { digest: string; }): Promise<{ ress: DockerResponse[]; stream: ReadableStream<ByteArray>; }>`

**Description**: Gets a ReadableStream to a specific blob. See: https://docs.docker.com/registry/spec/api/#get-blob

#### `deleteManifest(opts: { ref: string; }): Promise<void>`

**Description**: Deletes a manifest from the registry.

#### `getManifest(opts: { ref: string; acceptManifestLists?: boolean; acceptOCIManifests?: boolean; followRedirects?: boolean; }): Promise<{ resp: DockerResponse; manifest: Manifest; }>`

**Description**: Retrieves a manifest from the registry.

#### `headBlob(opts: { digest: string; }): Promise<DockerResponse[]>`

**Description**: Performs a HEAD request for a specific blob identified by its digest.

#### `listAllTags(props?: { pageSize?: number; }): Promise<TagList>`

**Description**: Lists all tags for a repository.

#### `listTags(props?: { pageSize?: number; startingAfter?: string; }): Promise<TagList>`

**Description**: Lists tags for a repository, with pagination support.

#### `listTagsPaginated(props?: { pageSize?: number; }): AsyncGenerator<TagList>`

**Description**: Returns an async generator for paginated listing of tags.

#### `login(opts?: { pingRes?: DockerResponse; scope?: string; }): Promise<void>`

**Description**: Logs into the registry to obtain a session.

#### `performLogin(opts: { scope?: string; pingRes?: DockerResponse; }): Promise<AuthInfo>`

**Description**: Performs V2 login to the registry.

#### `ping(opts?: { headers?: Headers; expectStatus?: number[]; }): Promise<DockerResponse>`

**Description**: Pings the base URL of the registry to check its availability. See: https://docs.docker.com/registry/spec/api/#base

#### `putManifest(opts: { manifestData: ByteArray; ref: string; schemaVersion?: number; mediaType?: string; }): Promise<{ digest: string | null; location: string | null; }>`

**Description**: Puts (uploads) a manifest to the registry.

#### `supportsV2(): Promise<boolean>`

**Description**: Determines if the registry supports the v2 API. See: https://docs.docker.com/registry/spec/api/#api-version-check
```

--------------------------------

### ManifestOCI Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Defines the structure for an OCI image manifest.

```APIDOC
## ManifestOCI

### Description
Represents an OCI image manifest.

### Properties

- **mediaType** (string) - The media type of the manifest, expected to be "application/vnd.oci.image.manifest.v1+json".
- **schemaVersion** (number) - The schema version, expected to be 2.
- **config** (ManifestOCIDescriptor) - A descriptor for the image configuration.
- **layers** (Array<ManifestOCIDescriptor>) - An array of descriptors for the image layers.
- **annotations** (Record<string, string>) - Optional annotations for the manifest.
```

--------------------------------

### Add Docsy Package to Deno

Source: https://jsr.io/@dldc/docsy

Command to add the Docsy package to a Deno project.

```Shell
deno add jsr:@dldc/docsy

```

--------------------------------

### DockerResponse Methods

Source: https://jsr.io/@cloudydeno/docker-registry-client

Methods available on the DockerResponse interface for retrieving different parts of a Docker registry response.

```APIDOC
## DockerResponse Methods

### Description
Methods to extract specific data formats from a Docker registry response.

### Methods
- `dockerBody(): Promise<ByteArray>`: Retrieves the raw byte array body of the response.
- `dockerErrors(): Promise<Array<RegistryError>>`: Retrieves any errors associated with the response.
- `dockerJson(): Promise<unknown>`: Attempts to parse the response body as JSON.
- `dockerStream(): ReadableStream<ByteArray>`: Returns the response body as a readable stream of byte arrays.
- `dockerThrowable(baseMsg: string): Promise<Error>`: Throws an error based on the response, with a provided base message.
```

--------------------------------

### DockerResponse Methods

Source: https://jsr.io/@cloudydeno/docker-registry-client

Methods available on the DockerResponse interface for retrieving different parts of a Docker registry response.

```APIDOC
## DockerResponse

### Description
Represents a response from the Docker registry.

### Methods

#### `dockerBody(): Promise<ByteArray>`

- **Description**: Retrieves the body of the Docker registry response as a byte array.
- **Returns**: A Promise that resolves to a `ByteArray`.

#### `dockerErrors(): Promise<Array<RegistryError>>`

- **Description**: Retrieves any errors associated with the Docker registry response.
- **Returns**: A Promise that resolves to an array of `RegistryError` objects.

#### `dockerJson(): Promise<unknown>`

- **Description**: Attempts to parse the Docker registry response as JSON.
- **Returns**: A Promise that resolves to an unknown type, representing the parsed JSON.

#### `dockerStream(): ReadableStream<ByteArray>`

- **Description**: Returns the Docker registry response as a readable stream of byte arrays.
- **Returns**: A `ReadableStream` of `ByteArray`.
```

```APIDOC
#### `dockerThrowable(baseMsg: string): Promise<Error>`

- **Description**: Throws an error based on the registry response, prepended with a base message.
- **Parameters**:
  - **baseMsg** (string) - Required - The base message for the error.
- **Returns**: A Promise that resolves to an `Error` object.
```

--------------------------------

### Import Directly with JSR Specifier

Source: https://jsr.io/@deno/doc

Import all symbols directly using the JSR specifier for the @deno/doc package.

```typescript
import * as doc from "jsr:@deno/doc";

```

--------------------------------

### Manifest Type Alias

Source: https://jsr.io/@cloudydeno/docker-registry-client

Union type for different manifest formats.

```APIDOC
## Manifest Type Alias

### Description
A union type that represents any of the supported manifest formats: `ManifestV2`, `ManifestV2List`, `ManifestOCI`, or `ManifestOCIIndex`.
```

--------------------------------

### parseRepoAndRef

Source: https://jsr.io/@cloudydeno/docker-registry-client

Parses a docker repository and tag/digest string into a structured RegistryImage object. Supports formats like `[INDEX/]REPO[:TAG|@DIGEST]`.

```APIDOC
## parseRepoAndRef

### Description
Parse a docker repo and tag/digest string: [INDEX/]REPO[:TAG|@DIGEST]

### Signature
parseRepoAndRef(
arg: string,
defaultIndex?: string | RegistryIndex
): RegistryImage
```

--------------------------------

### parseRepoAndRef

Source: https://jsr.io/@cloudydeno/docker-registry-client

Parse a docker repo and tag/digest string.

```APIDOC
## Function: parseRepoAndRef

### Description
Parses a Docker repository and reference string (tag or digest) into a structured object. The format is `[INDEX/]REPO[:TAG|@DIGEST|:TAG@DIGEST]`.

### Signature
`parseRepoAndRef(arg: string, defaultIndex?: string | RegistryIndex): RegistryImage`
```

--------------------------------

### Import Document Parser Module Directly

Source: https://jsr.io/@baiq/document-parser

Import the entire document parser module using a jsr specifier for direct use in your Deno project.

```typescript
import * as document_parser from "jsr:@baiq/document-parser";
```

--------------------------------

### RegistryImage Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Represents an image in the Docker registry.

```APIDOC
## RegistryImage Interface

### Description
Represents an image identified within the Docker registry.

### Fields
- `canonicalRef`: (string) - The canonical reference of the image.
- `digest`: (string | null) - The image digest, if available.
- `tag`: (string | null) - The image tag, if available.
```

--------------------------------

### Line Element Syntax

Source: https://jsr.io/@dldc/docsy

Shows how line elements are defined, ending at the line's termination.

```Docsy Syntax
<Tag>Content

```

--------------------------------

### Import Package Symbols

Source: https://jsr.io/@eldt/docs

Import all symbols from the @eldt/docs package using a namespace import.

```typescript
import * as docs from "@eldt/docs";

```

--------------------------------

### Import Docker Registry Client Package with JSR Specifier

Source: https://jsr.io/@cloudydeno/docker-registry-client

Import the package directly using a JSR specifier.

```typescript
import * as docker_registry_client from "jsr:@cloudydeno/docker-registry-client";
```

--------------------------------

### Import doc Function

Source: https://jsr.io/@deno/doc

Import the doc function from the @deno/doc package for use in your Deno project.

```typescript
import { doc } from "@deno/doc";

```

--------------------------------

### ManifestV2Descriptor Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Descriptor for a Docker V2 manifest component.

```APIDOC
## ManifestV2Descriptor Interface

### Description
Describes a component of a Docker V2 manifest, such as the config or a layer.

### Fields
- `mediaType`: (string) - The media type of the component.
- `digest`: (string) - The digest of the component.
- `size`: (number) - The size of the component in bytes.
- `urls`: (Array<string>) - Optional URLs pointing to the component.
```

--------------------------------

### RegistryRepo Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Represents a repository within a Docker registry.

```APIDOC
## RegistryRepo Interface

### Description
Details of a repository within a Docker registry.

### Fields
- `canonicalName`: (string) - The canonical name of the repository.
- `localName`: (string) - The local name of the repository.
- `remoteName`: (string) - The remote name of the repository.
- `official`: (boolean) - Indicates if the repository is official.
- `index`: (RegistryIndex) - Information about the registry index this repository belongs to.
```

--------------------------------

### urlFromIndex

Source: https://jsr.io/@cloudydeno/docker-registry-client

Generates a registry endpoint URL from a RegistryIndex object, similar to Docker's registry endpoint logic.

```APIDOC
## urlFromIndex

### Description
Similar in spirit to docker.git:registry/endpoint.go#NewEndpoint().

### Signature
urlFromIndex(
index: RegistryIndex,
scheme?: "http" | "https"
): string
```

--------------------------------

### TagList Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Represents a list of tags for an image.

```APIDOC
## TagList Interface

### Description
Contains a list of tags associated with an image in the registry.

### Fields
- `name`: (string) - The name of the image.
- `tags`: (string[]) - An array of tag names.
- `child`: (string[]) - An array of child references.
- `manifest`: (Record<string, object>) - A map of manifest details, including size, media type, and timestamps.
```

--------------------------------

### parseIndex

Source: https://jsr.io/@cloudydeno/docker-registry-client

Parse a docker index name or index URL.

```APIDOC
## Function: parseIndex

### Description
Parses a Docker index name or URL into a structured object.

### Signature
`parseIndex(arg?: string): RegistryIndex`
```

--------------------------------

### digestFromManifestStr

Source: https://jsr.io/@cloudydeno/docker-registry-client

Calculates the 'Docker-Content-Digest' header for a given manifest string.

```APIDOC
## Function: digestFromManifestStr

### Description

Calculates the 'Docker-Content-Digest' header value for a given manifest string.

### Parameters

- **manifestStr** (string) - Required - The manifest string to process.
```

--------------------------------

### Import Package Directly with JSR Specifier

Source: https://jsr.io/@cloudydeno/doci

Import the package directly using its JSR specifier. This method is useful for direct imports without prior 'deno add' command.

```typescript
import * as doci from "jsr:@cloudydeno/doci";

```

--------------------------------

### Import Package with Alias

Source: https://jsr.io/@cloudydeno/doci

Import the package using an alias for cleaner code. Ensure the package is added to your project first.

```typescript
import * as doci from "@cloudydeno/doci";

```

--------------------------------

### digestFromManifestStr

Source: https://jsr.io/@cloudydeno/docker-registry-client

Calculate the 'Docker-Content-Digest' header for the given manifest string.

```APIDOC
## Function: digestFromManifestStr

### Description
Calculates the 'Docker-Content-Digest' header value for a given manifest string.

### Signature
`digestFromManifestStr(manifestStr: string): Promise<string>`
```

--------------------------------

### ManifestOCIDescriptor Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Descriptor for an OCI manifest component.

```APIDOC
## ManifestOCIDescriptor Interface

### Description
Describes a component of an OCI manifest, such as the config or a layer.

### Fields
- `mediaType`: (string) - The media type of the component.
- `digest`: (string) - The digest of the component.
- `size`: (number) - The size of the component in bytes.
- `urls`: (Array<string>) - Optional URLs pointing to the component.
```

--------------------------------

### DockerJsonClient

Source: https://jsr.io/@cloudydeno/docker-registry-client

Client for interacting with Docker registries using JSON-based API requests.

```APIDOC
## DockerJsonClient

### Description
Client for interacting with Docker registries using JSON-based API requests.

### Constructor
DockerJsonClient(options: { name?: string; accept?: string; contentType?: string; url: string; userAgent: string; client?: Deno.HttpClient; })

### Properties
- **accept**: string
- **client**: Deno.HttpClient
- **contentType**: string
- **name**: string
- **url**: string
- **userAgent**: string

### Methods
- **request(opts: HttpReqOpts): Promise<DockerResponse>**
  Makes a request to the Docker registry.
```

--------------------------------

### RegistryIndex Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Represents an index of a registry.

```APIDOC
## RegistryIndex Interface

### Description
Information about a registry index.

### Fields
- `name`: (string) - The name of the registry index.
- `scheme`: ("https" | "http") - The protocol scheme used by the index.
- `official`: (boolean) - Indicates if the index is official.
```

--------------------------------

### ManifestOCIIndex Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Represents an OCI image index.

```APIDOC
## ManifestOCIIndex Interface

### Description
Represents an OCI image index, which is a list of manifests for different platforms.

### Fields
- `mediaType`: (string) - Must be "application/vnd.oci.image.index.v1+json".
- `schemaVersion`: (number) - Must be 2.
- `manifests`: (Array<object>) - An array of manifest descriptors, each including media type, digest, size, and optional platform information.
- `annotations`: (Record<string, string>) - Optional annotations for the index.
```

--------------------------------

### ManifestOCIIndex Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Defines the structure for an OCI image index.

```APIDOC
## ManifestOCIIndex

### Description
Represents an OCI image index.

### Properties

- **mediaType** (string) - The media type of the index, expected to be "application/vnd.oci.image.index.v1+json".
- **schemaVersion** (number) - The schema version, expected to be 2.
- **manifests** (Array<object>) - An array of manifest descriptors within the index. Each manifest object includes `mediaType`, `digest`, `size`, and an optional `platform` object.
- **annotations** (Record<string, string>) - Optional annotations for the index.
```

--------------------------------

### Import VERSION Symbol with Alias

Source: https://jsr.io/@elysium/docs

Import the VERSION symbol from the @elysium/docs package using its scoped name.

```typescript
import { VERSION } from "@elysium/docs";

```

--------------------------------

### HttpError

Source: https://jsr.io/@cloudydeno/docker-registry-client

Error representing an HTTP-related issue with a Docker registry response.

```APIDOC
## HttpError

### Description
Error representing an HTTP-related issue with a Docker registry response.

### Constructor
HttpError(
resp: DockerResponse,
errors: RegistryError[],
message: string
)

### Properties
- **name**: string
```

--------------------------------

### Extract Content from EPUB File

Source: https://jsr.io/@baiq/document-parser

Parses an EPUB archive to gather paragraphs and referenced images from each chapter. The results are structured by page, detailing the images found on each.

```typescript
import { extractEPUBContent } from "@baiq/document-parser";
const result = await extractEPUBContent("book.epub", "./out");
console.log(result.pages.map((p) => p.images.length));
```

--------------------------------

### AuthInfo Type Alias

Source: https://jsr.io/@cloudydeno/docker-registry-client

Defines possible authentication methods.

```APIDOC
## AuthInfo Type Alias

### Description
Represents the different types of authentication information supported.

### Types
- `{ type: "None" }`: No authentication required.
- `{ type: "Basic", username: string, password: string }`: Basic authentication with username and password.
- `{ type: "Bearer", token: string }`: Bearer token authentication.
```

--------------------------------

### Self Closing Element

Source: https://jsr.io/@dldc/docsy

Illustrates the syntax for self-closing elements.

```Docsy Syntax
</Tag/>
```

--------------------------------

### parseIndex

Source: https://jsr.io/@cloudydeno/docker-registry-client

Parses a docker index name or index URL into a structured RegistryIndex object.

```APIDOC
## parseIndex

### Description
Parse a docker index name or index URL.

### Signature
parseIndex(arg?: string): RegistryIndex
```

--------------------------------

### Extract Specific Pages from PDF

Source: https://jsr.io/@baiq/document-parser

Creates a new PDF file containing only the specified pages from an existing PDF. Returns the output path of the newly created PDF.

```typescript
import { extractPagesFromPDF } from "@baiq/document-parser";
const outPath = await extractPagesFromPDF("file.pdf", [1, 3]);
console.log(outPath);
```

--------------------------------

### Import test_doc Directly with JSR Specifier

Source: https://jsr.io/@babia-test/docs

Import the test_doc function directly using the JSR specifier.

```typescript
import { test_doc } from "jsr:@babia-test/docs";

```

--------------------------------

### ManifestVerificationError

Source: https://jsr.io/@cloudydeno/docker-registry-client

Error indicating a failure during manifest verification.

```APIDOC
## ManifestVerificationError

### Description
Error indicating a failure during manifest verification.

### Constructor
ManifestVerificationError(message: string, init?: { cause?: any; })

### Properties
- **name**: string
```

--------------------------------

### Import Package with JSR Specifier

Source: https://jsr.io/@devmode/docs-example

Alternative method to import the package directly using a JSR specifier.

```typescript
import * as docs_example from "jsr:@devmode/docs-example";
```

--------------------------------

### RegistryError Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Represents an error returned by the Docker registry.

```APIDOC
## RegistryError Interface

### Description
Structure for errors returned by the Docker registry API.

### Fields
- `code`: (string) - The error code.
- `message`: (string) - The error message.
- `detail`: (string) - Additional details about the error.
```

--------------------------------

### DownloadError

Source: https://jsr.io/@cloudydeno/docker-registry-client

Error indicating a failure during a download operation.

```APIDOC
## DownloadError

### Description
Error indicating a failure during a download operation.

### Constructor
DownloadError(message: string, init?: { cause?: any; })

### Properties
- **name**: string
```

--------------------------------

### ByteArray Type Alias

Source: https://jsr.io/@cloudydeno/docker-registry-client

Alias for Uint8Array.

```APIDOC
## ByteArray Type Alias

### Description
An alias for `Uint8Array`, representing a sequence of bytes. This is compatible with TypeScript 5.7's `ReturnType<Uint8Array['slice']>`.
```

--------------------------------

### ManifestOCIDescriptor Interface

Source: https://jsr.io/@cloudydeno/docker-registry-client

Describes a descriptor for an OCI image manifest component (config or layer).

```APIDOC
## ManifestOCIDescriptor

### Description
Describes a component of an OCI image manifest.

### Properties

- **mediaType** (string) - The media type of the component.
- **digest** (string) - The digest of the component.
- **size** (number) - The size of the component in bytes.
- **urls** (Array<string>) - Optional URLs pointing to the component.
```

--------------------------------

### ApiError

Source: https://jsr.io/@cloudydeno/docker-registry-client

Base class for custom error types in the Docker Registry Client.

```APIDOC
## ApiError

### Description
Base class for custom error classes.

### Constructor
ApiError(message: string, init?: { cause?: any; })
```

--------------------------------

### AuthInfo Type Alias

Source: https://jsr.io/@cloudydeno/docker-registry-client

Defines the possible authentication information structures.

```APIDOC
## AuthInfo

### Description
Represents different types of authentication information.

### Types

- **None**: No authentication required.
- **Basic**: Basic authentication with `username` and `password`.
- **Bearer**: Bearer token authentication with `token`.
```

--------------------------------

### Import VERSION Symbol Directly

Source: https://jsr.io/@elysium/docs

Import the VERSION symbol directly using the jsr specifier.

```typescript
import { VERSION } from "jsr:@elysium/docs";

```

--------------------------------

### isLocalhost

Source: https://jsr.io/@cloudydeno/docker-registry-client

Checks if the provided host string represents a localhost address.

```APIDOC
## isLocalhost

### Description
Checks if the provided host string represents a localhost address.

### Signature
isLocalhost(host: string): boolean
```

--------------------------------

### InvalidManifestError

Source: https://jsr.io/@cloudydeno/docker-registry-client

Error indicating that a manifest is invalid or malformed.

```APIDOC
## InvalidManifestError

### Description
Error indicating that a manifest is invalid or malformed.

### Constructor
InvalidManifestError(message: string, init?: { cause?: any; })

### Properties
- **name**: string
```

--------------------------------

### BadDigestError

Source: https://jsr.io/@cloudydeno/docker-registry-client

Error indicating that a digest verification failed.

```APIDOC
## BadDigestError

### Description
Error indicating that a digest verification failed.

### Constructor
BadDigestError(message: string, init?: { cause?: any; })

### Properties
- **name**: string
```

--------------------------------

### InvalidContentError

Source: https://jsr.io/@cloudydeno/docker-registry-client

Error indicating that the received content is not in the expected format.

```APIDOC
## InvalidContentError

### Description
Error indicating that the received content is not in the expected format.

### Constructor
InvalidContentError(message: string, init?: { cause?: any; })

### Properties
- **name**: string
```

--------------------------------

### splitIntoTwo

Source: https://jsr.io/@cloudydeno/docker-registry-client

Splits a string into two parts based on a separator. Returns a tuple of one or two strings.

```APIDOC
## splitIntoTwo

### Description
Splits a string into two parts based on a separator.

### Signature
splitIntoTwo(
str: string,
sep: string
): [string] | [string, string]
```

--------------------------------

### Import Directly with JSR Specifier

Source: https://jsr.io/@eldt/docs

Import symbols directly using the JSR specifier for the @eldt/docs package.

```typescript
import * as docs from "jsr:@eldt/docs";

```

--------------------------------

### InternalError

Source: https://jsr.io/@cloudydeno/docker-registry-client

Error indicating an internal issue within the client or registry.

```APIDOC
## InternalError

### Description
Error indicating an internal issue within the client or registry.

### Constructor
InternalError(message: string, init?: { cause?: any; })

### Properties
- **name**: string
```

--------------------------------

### TooManyRedirectsError

Source: https://jsr.io/@cloudydeno/docker-registry-client

Error indicating that too many redirects were encountered.

```APIDOC
## TooManyRedirectsError

### Description
Error indicating that too many redirects were encountered.

### Constructor
TooManyRedirectsError(message: string, init?: { cause?: any; })

### Properties
- **name**: string
```

--------------------------------

### Extract Content from PDF File

Source: https://jsr.io/@baiq/document-parser

This function utilizes external tools (`mutool` and `pdfimages`) to extract text and embedded images from each page of a PDF file. The output includes the total number of pages found.

```typescript
import { extractPDFContent } from "@baiq/document-parser";
const result = await extractPDFContent("file.pdf", "./out");
console.log(result.pages.length);
```

--------------------------------

### UploadError

Source: https://jsr.io/@cloudydeno/docker-registry-client

Error indicating a failure during an upload operation.

```APIDOC
## UploadError

### Description
Error indicating a failure during an upload operation.

### Constructor
UploadError(message: string, init?: { cause?: any; })

### Properties
- **name**: string
```

--------------------------------

### Extract Content from DOCX File

Source: https://jsr.io/@baiq/document-parser

Use this function to read a DOCX file and extract all paragraphs and embedded images. The entire document is treated as a single page. Images are written to the specified output directory.

```typescript
import { extractDOCXContent } from "@baiq/document-parser";
const result = await extractDOCXContent("document.docx", "./out");
console.log(result.pages[0].paragraphs);
```
Tokens:
Raw