URLBuilder class

Package:

@azure/ms-rest-js

Classe qui gère la création, la modification et l’analyse d’URL.

Méthodes

appendPath(string | undefined)	Ajoutez le chemin d’accès fourni au chemin existant de cette URL. Si le chemin d’accès fourni contient une requête, il sera également ajouté à cette URL.
getHost()	Obtenez l’hôte qui a été défini dans cette URL.
getPath()	Obtenez le chemin d’accès défini dans cette URL.
getPort()	Obtenez le port qui a été défini dans cette URL.
getQuery()	Obtenez la requête dans cette URL.
getQueryParameterValue(string)	Obtenez la valeur du paramètre de requête avec le nom du paramètre de requête fourni. Si aucun paramètre de requête n’existe avec le nom fourni, undefined est retourné.
getScheme()	Obtenez le schéma qui a été défini dans cette URL.
parse(string)
replaceAll(string, string)	Si la valeur de recherche fournie est trouvée dans cet URLBuilder, remplacez-la par la valeur de remplacement fournie.
setHost(string | undefined)	Définissez l’hôte pour cette URL. Si l’hôte fourni contient d’autres parties d’une URL (par exemple, un port, un chemin d’accès ou une requête), ces parties sont également ajoutées à cette URL.
setPath(string | undefined)	Définissez le chemin d’accès de cette URL. Si le chemin d’accès fourni contient une requête, il sera également ajouté à cette URL.
setPort(string | number | undefined)	Définissez le port de cette URL. Si le port fourni contient d’autres parties d’une URL (par exemple, un chemin d’accès ou une requête), ces parties sont également ajoutées à cette URL.
setQuery(string | undefined)	Définissez la requête dans cette URL.
setQueryParameter(string, any)	Définissez un paramètre de requête avec le nom et la valeur fournis dans la requête de cette URL. Si la valeur du paramètre de requête fournie n’est pas définie ou vide, le paramètre de requête est supprimé s’il existait.
setScheme(string | undefined)	Définissez le schéma/protocole pour cette URL. Si le schéma fourni contient d’autres parties d’une URL (par exemple, un hôte, un port, un chemin ou une requête), ces parties seront également ajoutées à cette URL.
toString()

Détails de la méthode

appendPath(string | undefined)

Ajoutez le chemin d’accès fourni au chemin existant de cette URL. Si le chemin d’accès fourni contient une requête, il sera également ajouté à cette URL.

function appendPath(path: string | undefined)

Paramètres

path

string | undefined

getHost()

Obtenez l’hôte qui a été défini dans cette URL.

function getHost(): string | undefined

Retours

string | undefined

getPath()

Obtenez le chemin d’accès défini dans cette URL.

function getPath(): string | undefined

Retours

string | undefined

getPort()

Obtenez le port qui a été défini dans cette URL.

function getPort(): string | undefined

Retours

string | undefined

getQuery()

Obtenez la requête dans cette URL.

function getQuery(): string | undefined

Retours

string | undefined

getQueryParameterValue(string)

Obtenez la valeur du paramètre de requête avec le nom du paramètre de requête fourni. Si aucun paramètre de requête n’existe avec le nom fourni, undefined est retourné.

function getQueryParameterValue(queryParameterName: string): string | string[] | undefined

Paramètres

queryParameterName

string

Retours

string | string[] | undefined

getScheme()

Obtenez le schéma qui a été défini dans cette URL.

function getScheme(): string | undefined

Retours

string | undefined

parse(string)

static function parse(text: string): URLBuilder

Paramètres

text

string

Retours

URLBuilder

replaceAll(string, string)

Si la valeur de recherche fournie est trouvée dans cet URLBuilder, remplacez-la par la valeur de remplacement fournie.

function replaceAll(searchValue: string, replaceValue: string)

Paramètres

searchValue

string

replaceValue

string

setHost(string | undefined)

Définissez l’hôte pour cette URL. Si l’hôte fourni contient d’autres parties d’une URL (par exemple, un port, un chemin d’accès ou une requête), ces parties sont également ajoutées à cette URL.

function setHost(host: string | undefined)

Paramètres

host

string | undefined

setPath(string | undefined)

Définissez le chemin d’accès de cette URL. Si le chemin d’accès fourni contient une requête, il sera également ajouté à cette URL.

function setPath(path: string | undefined)

Paramètres

path

string | undefined

setPort(string | number | undefined)

Définissez le port de cette URL. Si le port fourni contient d’autres parties d’une URL (par exemple, un chemin d’accès ou une requête), ces parties sont également ajoutées à cette URL.

function setPort(port: string | number | undefined)

Paramètres

port

string | number | undefined

setQuery(string | undefined)

Définissez la requête dans cette URL.

function setQuery(query: string | undefined)

Paramètres

query

string | undefined

setQueryParameter(string, any)

Définissez un paramètre de requête avec le nom et la valeur fournis dans la requête de cette URL. Si la valeur du paramètre de requête fournie n’est pas définie ou vide, le paramètre de requête est supprimé s’il existait.

function setQueryParameter(queryParameterName: string, queryParameterValue: any)

Paramètres

queryParameterName

string

queryParameterValue

any

setScheme(string | undefined)

Définissez le schéma/protocole pour cette URL. Si le schéma fourni contient d’autres parties d’une URL (par exemple, un hôte, un port, un chemin ou une requête), ces parties seront également ajoutées à cette URL.

function setScheme(scheme: string | undefined)

Paramètres

scheme

string | undefined

toString()

function toString(): string

Retours

string