From 478b76001c5c0c3eb02b840284a3e97eff72d5ba Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Tue, 6 Feb 2024 16:09:53 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- functions/base32cid.html | 2 +- functions/cid.html | 2 +- functions/cidPath.html | 2 +- functions/ipfsPath.html | 2 +- functions/ipfsSubdomain.html | 2 +- functions/ipfsUrl.html | 2 +- functions/ipnsPath.html | 2 +- functions/ipnsSubdomain.html | 2 +- functions/ipnsUrl.html | 2 +- functions/multiaddr.html | 2 +- functions/multihash.html | 2 +- functions/path.html | 2 +- functions/peerMultiaddr.html | 2 +- functions/subdomain.html | 2 +- functions/url.html | 2 +- functions/urlOrPath.html | 2 +- index.html | 2 +- variables/pathGatewayPattern.html | 2 +- variables/pathPattern.html | 2 +- variables/subdomainGatewayPattern.html | 2 +- 20 files changed, 20 insertions(+), 20 deletions(-) diff --git a/functions/base32cid.html b/functions/base32cid.html index da72208..168e909 100644 --- a/functions/base32cid.html +++ b/functions/base32cid.html @@ -1,3 +1,3 @@ base32cid | is-ipfs

Function base32cid

  • base32cid(cid): boolean

  • Returns true if the provided string is a valid CID in Base32 encoding or false otherwise.

    -

    Parameters

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/cid.html b/functions/cid.html index ed147c1..a60746c 100644 --- a/functions/cid.html +++ b/functions/cid.html @@ -1 +1 @@ -cid | is-ipfs

Function cid

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +cid | is-ipfs

Function cid

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/cidPath.html b/functions/cidPath.html index daadc80..b2c9cf9 100644 --- a/functions/cidPath.html +++ b/functions/cidPath.html @@ -1,3 +1,3 @@ cidPath | is-ipfs

Function cidPath

  • cidPath(path): boolean

  • Returns true if the provided string is a valid "CID path" (IPFS path without /ipfs/ prefix) or false otherwise.

    -

    Parameters

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/ipfsPath.html b/functions/ipfsPath.html index d8d827f..5ce1076 100644 --- a/functions/ipfsPath.html +++ b/functions/ipfsPath.html @@ -1,3 +1,3 @@ ipfsPath | is-ipfs

Function ipfsPath

  • ipfsPath(path): boolean

  • Returns true if the provided string is a valid IPFS or IPNS path or false otherwise.

    -

    Parameters

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/ipfsSubdomain.html b/functions/ipfsSubdomain.html index c97c0db..83adb7d 100644 --- a/functions/ipfsSubdomain.html +++ b/functions/ipfsSubdomain.html @@ -1,3 +1,3 @@ ipfsSubdomain | is-ipfs

Function ipfsSubdomain

  • ipfsSubdomain(url): boolean

  • Returns true if the provided url string includes a valid IPFS subdomain (case-insensitive CIDv1) or false otherwise.

    -

    Parameters

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/ipfsUrl.html b/functions/ipfsUrl.html index a572625..ca77743 100644 --- a/functions/ipfsUrl.html +++ b/functions/ipfsUrl.html @@ -1,3 +1,3 @@ ipfsUrl | is-ipfs

Function ipfsUrl

  • ipfsUrl(url): boolean

  • Returns true if the provided string is a valid IPFS url or false otherwise.

    -

    Parameters

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/ipnsPath.html b/functions/ipnsPath.html index 5d2fddd..404452e 100644 --- a/functions/ipnsPath.html +++ b/functions/ipnsPath.html @@ -1,3 +1,3 @@ ipnsPath | is-ipfs

Function ipnsPath

  • ipnsPath(path): boolean

  • Returns true if the provided string is a valid IPNS path or false otherwise.

    -

    Parameters

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/ipnsSubdomain.html b/functions/ipnsSubdomain.html index f625e58..3e41274 100644 --- a/functions/ipnsSubdomain.html +++ b/functions/ipnsSubdomain.html @@ -8,4 +8,4 @@
  • To ensure IPNS record exists, make a call to /api/v0/name/resolve?arg=<ipnsid>
  • To ensure DNSLink exists, make a call to /api/v0/dns?arg=<fqdn>
    • -

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/ipnsUrl.html b/functions/ipnsUrl.html index a84c8d2..34c565a 100644 --- a/functions/ipnsUrl.html +++ b/functions/ipnsUrl.html @@ -1,3 +1,3 @@ ipnsUrl | is-ipfs

    Function ipnsUrl

    • ipnsUrl(url): boolean

    • Returns true if the provided string is a valid IPNS url or false otherwise.

      -

      Parameters

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/multiaddr.html b/functions/multiaddr.html index c03084a..2add705 100644 --- a/functions/multiaddr.html +++ b/functions/multiaddr.html @@ -1 +1 @@ -multiaddr | is-ipfs

    Function multiaddr

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +multiaddr | is-ipfs

    Function multiaddr

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/multihash.html b/functions/multihash.html index 18732aa..63a4b9d 100644 --- a/functions/multihash.html +++ b/functions/multihash.html @@ -1 +1 @@ -multihash | is-ipfs

    Function multihash

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +multihash | is-ipfs

    Function multihash

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/path.html b/functions/path.html index 67916e0..99b99c6 100644 --- a/functions/path.html +++ b/functions/path.html @@ -1 +1 @@ -path | is-ipfs

    Function path

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +path | is-ipfs

    Function path

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/peerMultiaddr.html b/functions/peerMultiaddr.html index a446ade..b8cf33c 100644 --- a/functions/peerMultiaddr.html +++ b/functions/peerMultiaddr.html @@ -1 +1 @@ -peerMultiaddr | is-ipfs

    Function peerMultiaddr

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +peerMultiaddr | is-ipfs

    Function peerMultiaddr

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/subdomain.html b/functions/subdomain.html index 8183ce1..feb0f98 100644 --- a/functions/subdomain.html +++ b/functions/subdomain.html @@ -1,3 +1,3 @@ subdomain | is-ipfs

    Function subdomain

    • subdomain(url): boolean

    • Returns true if the provided url string includes a valid IPFS, looks like an IPNS/DNSLink subdomain or false otherwise.

      -

      Parameters

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/url.html b/functions/url.html index f441d45..e8fccc1 100644 --- a/functions/url.html +++ b/functions/url.html @@ -1,3 +1,3 @@ url | is-ipfs

    Function url

    • url(url): boolean

    • Returns true if the provided string is a valid IPFS or IPNS url or false otherwise.

      -

      Parameters

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/urlOrPath.html b/functions/urlOrPath.html index 046a040..23abd6b 100644 --- a/functions/urlOrPath.html +++ b/functions/urlOrPath.html @@ -1,3 +1,3 @@ urlOrPath | is-ipfs

    Function urlOrPath

    • urlOrPath(x): boolean

    • Returns true if the provided string is a valid IPFS or IPNS url or path or false otherwise.

      -

      Parameters

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/index.html b/index.html index 6d894d4..c90c4a9 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,5 @@ is-ipfs

    is-ipfs

    is-ipfs

    codecov -CI

    +CI

    A set of utilities to help identify IPFS resources on the web

    diff --git a/variables/pathGatewayPattern.html b/variables/pathGatewayPattern.html index 92fef69..9abe230 100644 --- a/variables/pathGatewayPattern.html +++ b/variables/pathGatewayPattern.html @@ -1 +1 @@ -pathGatewayPattern | is-ipfs

    Variable pathGatewayPatternConst

    pathGatewayPattern: RegExp = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +pathGatewayPattern | is-ipfs

    Variable pathGatewayPatternConst

    pathGatewayPattern: RegExp = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/pathPattern.html b/variables/pathPattern.html index e43f5bb..b4f451b 100644 --- a/variables/pathPattern.html +++ b/variables/pathPattern.html @@ -1 +1 @@ -pathPattern | is-ipfs

    Variable pathPatternConst

    pathPattern: RegExp = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +pathPattern | is-ipfs

    Variable pathPatternConst

    pathPattern: RegExp = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/subdomainGatewayPattern.html b/variables/subdomainGatewayPattern.html index a401ba6..36b3e94 100644 --- a/variables/subdomainGatewayPattern.html +++ b/variables/subdomainGatewayPattern.html @@ -1 +1 @@ -subdomainGatewayPattern | is-ipfs

    Variable subdomainGatewayPatternConst

    subdomainGatewayPattern: RegExp = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +subdomainGatewayPattern | is-ipfs

    Variable subdomainGatewayPatternConst

    subdomainGatewayPattern: RegExp = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file