Skip to content

Commit 090fe79

Browse files
authored
fix: deprecate DNS resolvers (#426)
Adds deprecation notices to all DNS resolvers
1 parent 43bf9a2 commit 090fe79

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed

src/index.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -672,6 +672,8 @@ export function fromNodeAddress (addr: NodeAddress, transport: string): Multiadd
672672
* console.info(ma2)
673673
* // '/ip4/127.0.0.1'
674674
* ```
675+
*
676+
* @deprecated Will be removed in a future release
675677
*/
676678
export function fromTuples (tuples: Tuple[]): Multiaddr {
677679
return multiaddr(tuples.map(([code, value]) => {
@@ -706,6 +708,8 @@ export function fromTuples (tuples: Tuple[]): Multiaddr {
706708
* console.info(ma2)
707709
* // '/ip4/127.0.0.1'
708710
* ```
711+
*
712+
* @deprecated Will be removed in a future release
709713
*/
710714
export function fromStringTuples (tuples: StringTuple[]): Multiaddr {
711715
return multiaddr(tuples.map(([code, value]) => {
@@ -737,6 +741,8 @@ export function fromStringTuples (tuples: StringTuple[]): Multiaddr {
737741
* isName(multiaddr('/dns/ipfs.io'))
738742
* // true
739743
* ```
744+
*
745+
* @deprecated DNS resolving will be removed in a future release
740746
*/
741747
export function isName (addr: Multiaddr): boolean {
742748
if (!isMultiaddr(addr)) {

src/resolvers/dnsaddr.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ class RecursionLimitError extends Error {
1515
}
1616
}
1717

18+
/**
19+
* @deprecated DNS resolving will be removed in a future release
20+
*/
1821
export interface DNSADDROptions extends AbortOptions {
1922
/**
2023
* An optional DNS resolver
@@ -30,6 +33,9 @@ export interface DNSADDROptions extends AbortOptions {
3033
maxRecursiveDepth?: number
3134
}
3235

36+
/**
37+
* @deprecated DNS resolving will be removed in a future release
38+
*/
3339
export const dnsaddrResolver: Resolver<DNSADDROptions> = async function dnsaddrResolver (ma: Multiaddr, options: DNSADDROptions = {}): Promise<string[]> {
3440
const recursionLimit = options.maxRecursiveDepth ?? MAX_RECURSIVE_DEPTH
3541

src/resolvers/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
import type { AbortOptions, Multiaddr } from '../index.js'
22

3+
/**
4+
* @deprecated DNS resolving will be removed in a future release
5+
*/
36
export interface Resolver<ResolveOptions extends AbortOptions = AbortOptions> {
47
(ma: Multiaddr, options?: ResolveOptions): Promise<string[]>
58
}

0 commit comments

Comments
 (0)