Partager via

URLBuilder class

  • Référence
Paquet:
@azure/core-http

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

Méthodes

appendPath(undefined | string)

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

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

Obtenez le chemin qui a été 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 de 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)

Analyse une URL de chaîne donnée dans un nouvel URLBuilder.
replaceAll(string, string)

Si la valeur de recherche fournie se trouve dans cette URLBuilder, remplacez-la par la valeur replaceValue fournie.
setHost(undefined | string)

Définissez l’hôte pour cette URL. Si l’hôte fourni contient d’autres parties d’une URL (comme un port, un chemin ou une requête), ces parties sont également ajoutées à cette URL.
setPath(undefined | string)

Définissez le chemin d’accès de cette URL. Si le chemin fourni contient une requête, elle sera également ajoutée à cette URL.
setPort(undefined | string | number)

Définissez le port pour 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(undefined | string)

Définissez la requête dans cette URL.
setQueryParameter(string, unknown)

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 existe.
setScheme(undefined | string)

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

Sérialise l’URL sous forme de chaîne.

Détails de la méthode

appendPath(undefined | string)

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

function appendPath(path: undefined | string)

Paramètres

path

undefined | string

getHost()

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

function getHost(): undefined | string

Retours

undefined | string

getPath()

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

function getPath(): undefined | string

Retours

undefined | string

getPort()

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

function getPort(): undefined | string

Retours

undefined | string

getQuery()

Obtenez la requête dans cette URL.

function getQuery(): undefined | string

Retours

undefined | string

getQueryParameterValue(string)

Obtenez la valeur du paramètre de requête avec le nom de 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): undefined | string | string[]

Paramètres

queryParameterName

string

Retours

undefined | string | string[]

getScheme()

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

function getScheme(): undefined | string

Retours

undefined | string

parse(string)

Analyse une URL de chaîne donnée dans un nouvel URLBuilder.

static function parse(text: string): URLBuilder

Paramètres

text

string

Retours

URLBuilder

replaceAll(string, string)

Si la valeur de recherche fournie se trouve dans cette URLBuilder, remplacez-la par la valeur replaceValue fournie.

function replaceAll(searchValue: string, replaceValue: string)

Paramètres

searchValue

string

replaceValue

string

setHost(undefined | string)

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

function setHost(host: undefined | string)

Paramètres

host

undefined | string

setPath(undefined | string)

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

function setPath(path: undefined | string)

Paramètres

path

undefined | string

setPort(undefined | string | number)

Définissez le port pour 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: undefined | string | number)

Paramètres

port

undefined | string | number

setQuery(undefined | string)

Définissez la requête dans cette URL.

function setQuery(query: undefined | string)

Paramètres

query

undefined | string

setQueryParameter(string, unknown)

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 existe.

function setQueryParameter(queryParameterName: string, queryParameterValue: unknown)

Paramètres

queryParameterName

string

queryParameterValue

unknown

setScheme(undefined | string)

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

function setScheme(scheme: undefined | string)

Paramètres

scheme

undefined | string

toString()

Sérialise l’URL sous forme de chaîne.

function toString(): string

Retours

string

l’URL sous forme de chaîne.