Condividi tramite


@azure/storage-file package

Classi

Aborter

Un'istanza di interruzione implementa l'interfaccia AbortSignal, può interrompere le richieste HTTP.

  • Chiamare Aborter.none per creare una nuova istanza di Aborter senza timeout.
  • Chiamare Aborter.timeout() per creare una nuova istanza di Aborter con timeout.

Per un'istanza esistente interrotta:

  • Chiamare aborter.withTimeout() per creare e restituire un'istanza figlio di Aborter con timeout.
  • Chiamare aborter.withValue(key, value) per creare e restituire un'istanza figlio Aborter con coppia chiave/valore.
  • Chiamare aborter.abort() per interrompere l'istanza corrente e tutte le istanze figlio.
  • Chiamare aborter.getValue(key) per cercare e ottenere valore con la chiave corrispondente dall'interruzione corrente a tutti gli elementi padre.
AccountSASPermissions

DISPONIBILE SOLO IN NODE.JS RUNTIME. Si tratta di una classe helper per costruire una stringa che rappresenta le autorizzazioni concesse da un AccountSAS. L'impostazione di un valore su true indica che qualsiasi firma di accesso condiviso che usa queste autorizzazioni concederà le autorizzazioni per tale operazione. Una volta impostati tutti i valori, questo valore deve essere serializzato con toString e impostato come campo delle autorizzazioni in un oggetto <xref:IAccountSASSignatureValues>. È possibile costruire la stringa di autorizzazioni senza questa classe, ma l'ordine delle autorizzazioni è particolare e questa classe garantisce la correttezza.

AccountSASResourceTypes

DISPONIBILE SOLO IN NODE.JS RUNTIME. Si tratta di una classe helper per costruire una stringa che rappresenta le risorse accessibili da un AccountSAS. L'impostazione di un valore su true indica che qualsiasi firma di accesso condiviso che usa queste autorizzazioni consentirà l'accesso a tale tipo di risorsa. Dopo aver impostato tutti i valori, deve essere serializzato con toString e impostato come campo delle risorse in un oggetto <xref:IAccountSASSignatureValues>. È possibile costruire la stringa di risorse senza questa classe, ma l'ordine delle risorse è particolare e questa classe garantisce la correttezza.

AccountSASServices

DISPONIBILE SOLO IN NODE.JS RUNTIME. Si tratta di una classe helper per costruire una stringa che rappresenta i servizi accessibili da un AccountSAS. L'impostazione di un valore su true indica che qualsiasi firma di accesso condiviso che usa queste autorizzazioni consentirà l'accesso a tale servizio. Una volta impostati tutti i valori, deve essere serializzato con toString e impostato come campo dei servizi in un oggetto <xref:IAccountSASSignatureValues>. È possibile costruire la stringa dei servizi senza questa classe, ma l'ordine dei servizi è particolare e questa classe garantisce la correttezza.

BrowserPolicyFactory

BrowserPolicyFactory è una classe factory che consente di generare oggetti BrowserPolicy.

DirectoryURL

DirectoryURL rappresenta un URL della directory di Archiviazione di Azure che consente di modificare i file e le directory.

FileSASPermissions

DISPONIBILE SOLO IN NODE.JS RUNTIME. Si tratta di una classe helper per costruire una stringa che rappresenta le autorizzazioni concesse da un ServiceSAS a un file. L'impostazione di un valore su true indica che qualsiasi firma di accesso condiviso che usa queste autorizzazioni concederà le autorizzazioni per tale operazione. Dopo aver impostato tutti i valori, deve essere serializzato con toString e impostato come campo delle autorizzazioni in un oggetto <xref:IFileSASSignatureValues>. È possibile costruire la stringa di autorizzazioni senza questa classe, ma l'ordine delle autorizzazioni è particolare e questa classe garantisce la correttezza.

FileSystemAttributes

Si tratta di una classe helper per costruire una stringa che rappresenta gli attributi NTFS in un file o in una directory.

FileURL

Un oggetto FileURL rappresenta un URL di un file di Archiviazione di Azure.

KeepAlivePolicyFactory

KeepAlivePolicyFactory è una classe factory che consente di generare oggetti KeepAlivePolicy.

LoggingPolicyFactory

LoggingPolicyFactory è una classe factory che consente di generare oggetti LoggingPolicy.

Pipeline

Classe Pipeline contenente i criteri di richiesta HTTP. È possibile creare una pipeline predefinita chiamando StorageURL.newPipeline(). In alternativa, è possibile creare una pipeline con criteri personalizzati dal costruttore di Pipeline. Vedere StorageURL.newPipeline() e i criteri forniti come riferimento prima di implementare la pipeline personalizzata.

RetryPolicyFactory

RetryPolicyFactory è una classe factory che consente di generare oggetti RetryPolicy.

SASQueryParameters

Rappresenta i componenti che costituiscono i parametri di query della firma di accesso condiviso di Archiviazione di Azure. Questo tipo non viene costruito direttamente dall'utente; viene generato solo dai tipi <xref:IAccountSASSignatureValues> e <xref:IFileSASSignatureValues>. Una volta generato, può essere codificato in un {@code String} e accodato direttamente a un URL(anche se è necessario prestare attenzione nel caso in cui siano presenti parametri di query esistenti, che potrebbero influire sui mezzi appropriati per accodare questi parametri di query). NOTA: le istanze di questa classe non sono modificabili.

ServiceURL

Un serviceURL rappresenta un URL del servizio file di archiviazione di Azure che consente di modificare le condivisioni file.

ShareSASPermissions

Si tratta di una classe helper per costruire una stringa che rappresenta le autorizzazioni concesse da un ServiceSAS a una condivisione. L'impostazione di un valore su true indica che qualsiasi firma di accesso condiviso che usa queste autorizzazioni concederà le autorizzazioni per tale operazione. Dopo aver impostato tutti i valori, deve essere serializzato con toString e impostato come campo delle autorizzazioni in un oggetto <xref:IFileSASSignatureValues>. È possibile costruire la stringa di autorizzazioni senza questa classe, ma l'ordine delle autorizzazioni è particolare e questa classe garantisce la correttezza.

ShareURL

ShareURL rappresenta un URL della condivisione di Archiviazione di Azure che consente di modificare le directory e i file.

StorageURL

Un Oggetto ServiceURL rappresenta una classe URL basata per ServiceURL, ContainerURL e così via.

TelemetryPolicyFactory

TelemetryPolicyFactory è una classe factory che consente di generare oggetti TelemetryPolicy.

UniqueRequestIDPolicyFactory

UniqueRequestIDPolicyFactory è una classe factory che consente di generare oggetti UniqueRequestIDPolicy.

AnonymousCredential

AnonymousCredential fornisce un membro credentialPolicyCreator usato per creare oggetti AnonymousCredentialPolicy. AnonymousCredentialPolicy viene usato con richieste HTTP(S) che leggono risorse pubbliche o da usare con firme di accesso condiviso.

Credential

Credential è una classe astratta per la firma delle richieste HTTP di Archiviazione di Azure. Questa classe ospiterà una factory credentialPolicyCreator che genera CredentialPolicy.

SharedKeyCredential

DISPONIBILE SOLO IN NODE.JS RUNTIME. SharedKeyCredential per l'autorizzazione della chiave dell'account del servizio archiviazione di Azure.

Directory

Classe che rappresenta una directory.

File

Classe che rappresenta un file.

Service

Classe che rappresenta un servizio.

Share

Classe che rappresenta una condivisione.

StorageClient
StorageClientContext
AnonymousCredentialPolicy

AnonymousCredentialPolicy viene usato con richieste HTTP(S) che leggono risorse pubbliche o da usare con firme di accesso condiviso.

BrowserPolicy

BrowserPolicy gestirà le differenze tra Node.js e il runtime del browser, tra cui:

  1. I browser memorizzano nella cache le richieste GET/HEAD aggiungendo intestazioni condizionali come "IF_MODIFIED_SINCE". BrowserPolicy è un criterio usato per aggiungere una query timestamp all'URL della richiesta GET/HEAD, evitando così la cache del browser.

  2. Rimuovere l'intestazione del cookie per la sicurezza

  3. Rimuovere l'intestazione content-length per evitare gli avvisi dei browser

CredentialPolicy

Criteri di credenziali usati per firmare le richieste HTTP(S) prima dell'invio. Si tratta di una classe astratta.

KeepAlivePolicy

KeepAlivePolicy è un criterio usato per controllare le impostazioni keep-alive per ogni richiesta.

LoggingPolicy

LoggingPolicy è un criterio usato per registrare le richieste.

RetryPolicy

Criteri di ripetizione dei tentativi con ripetizione esponenziale e ripetizione lineare implementati.

SharedKeyCredentialPolicy

SharedKeyCredentialPolicy è un criterio usato per firmare una richiesta HTTP con una chiave condivisa.

TelemetryPolicy

TelemetryPolicy è un criterio usato per contrassegnare l'intestazione dell'agente utente per ogni richiesta.

UniqueRequestIDPolicy

UniqueRequestIDPolicy genera un UUID come valore di intestazione x-ms-request-id.

Batch

Batch offre un'esecuzione parallela di base con limiti di concorrenza. Arresterà le operazioni di sinistra quando una dell'operazione eseguita genera un errore. Ma Batch non può annullare le operazioni in corso, è necessario annullarle manualmente.

BufferScheduler

Questa classe accetta un flusso leggibile Node.js come input e continua a leggere i dati dal flusso nella struttura del buffer interno fino a raggiungere maxBuffers. Ogni buffer disponibile tenterà di attivare il gestore in uscita. La struttura del buffer interno include una matrice di buffer in ingresso e una matrice di buffer in uscita. La matrice di buffer in ingresso include i buffer "vuoti" che possono essere riempiti con nuovi dati in ingresso. La matrice in uscita include i buffer riempiti da gestire da outgoingHandler. Ogni dimensione del buffer precedente è definita dal parametro bufferSize.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

<NUM_OF_ALL_BUFFERS = maxBuffers

SUGGERIMENTI PER IL MIGLIORAMENTO DELLE PRESTAZIONI:

  1. L'highWaterMark del flusso di input è preferibile impostare lo stesso valore con il parametro bufferSize, che eviterà le operazioni Buffer.concat().
  2. Il parallelismo deve impostare un valore inferiore a maxBuffers, utile per ridurre la possibilità quando un gestore in uscita attende i dati del flusso. in questa situazione, i gestori in uscita vengono bloccati. La coda in uscita non deve essere vuota.
RetriableReadableStream

DISPONIBILE SOLO IN NODE.JS RUNTIME. Un Node.js ReadableStream ritenta internamente quando termina in modo imprevisto ReadableStream interno.

Interfacce

IDirectoryCreateOptions
IDirectoryForceCloseHandlesSegmentOptions
IDirectoryListFilesAndDirectoriesSegmentOptions
IDirectoryListHandlesSegmentOptions
IDirectoryProperties
IFileCreateOptions
IFileDownloadOptions
IFileGetRangeListOptions

L'opzione è definita come parità con la definizione REST. Anche se non è pronta per essere usata ora, considerando che Crc64 del contenuto di origine non è accessibile.

IFileListHandlesSegmentOptions
IFileProperties
IFileStartCopyOptions
IFileUploadRangeOptions
ISetPropertiesResponse
IAccountSASSignatureValues

DISPONIBILE SOLO IN NODE.JS RUNTIME. IAccountSASSignatureValues viene usato per generare una firma di accesso condiviso per un account di archiviazione di Azure. Dopo aver impostato tutti i valori qui in modo appropriato, chiamare generateSASQueryParameters() per ottenere una rappresentazione della firma di accesso condiviso che può essere effettivamente applicata agli URL del file. Si noti che sia questa classe che <xref:SASQueryParameters> esistono perché la prima è modificabile e una rappresentazione logica mentre quest'ultima non è modificabile e usata per generare richieste REST effettive.

IFileSASSignatureValues

DISPONIBILE SOLO IN NODE.JS RUNTIME. IFileSASSignatureValues viene usato per generare token di firma di accesso condiviso del servizio file per condivisioni o file.

IIPRange

Intervallo IP consentito per una firma di accesso condiviso.

IRange

Intervallo per le operazioni del servizio.

IKeepAliveOptions

Interfaccia delle opzioni KeepAlivePolicy.

IRequestLogOptions

RequestLogOptions configura il comportamento dei criteri di ripetizione dei tentativi.

IPipelineOptions

Interfaccia di opzione per il costruttore Pipeline.

IRetryOptions

Interfaccia delle opzioni di ripetizione dei tentativi.

IServiceListSharesSegmentOptions
IShareCreateOptions
IShareCreateSnapshotOptions
IShareDeleteMethodOptions
ISignedIdentifier
INewPipelineOptions

Interfaccia dell'opzione per il metodo Pipeline.newPipeline.

ITelemetryOptions

Interfaccia delle opzioni TelemetryPolicy.

AccessPolicy

Criteri di accesso.

CorsRule

CORS è una funzionalità HTTP che consente a un'applicazione Web in esecuzione in un dominio di accedere alle risorse in un altro dominio. I Web browser implementano una restrizione di sicurezza nota come criteri di stessa origine che impediscono a una pagina Web di chiamare le API in un dominio diverso; CORS offre un modo sicuro per consentire a un dominio (dominio di origine) di chiamare le API in un altro dominio.

DirectoryCreateHeaders

Definisce le intestazioni per l'operazione di creazione.

DirectoryCreateOptionalParams

Parametri facoltativi.

DirectoryDeleteHeaders

Definisce le intestazioni per l'operazione Delete.

DirectoryDeleteMethodOptionalParams

Parametri facoltativi.

DirectoryForceCloseHandlesHeaders

Definisce le intestazioni per l'operazione ForceCloseHandles.

DirectoryForceCloseHandlesOptionalParams

Parametri facoltativi.

DirectoryGetPropertiesHeaders

Definisce le intestazioni per l'operazione GetProperties.

DirectoryGetPropertiesOptionalParams

Parametri facoltativi.

DirectoryItem

Elemento della directory elencato.

DirectoryListFilesAndDirectoriesSegmentHeaders

Definisce le intestazioni per l'operazione ListFilesAndDirectoriesSegment.

DirectoryListFilesAndDirectoriesSegmentOptionalParams

Parametri facoltativi.

DirectoryListHandlesHeaders

Definisce le intestazioni per l'operazione ListHandles.

DirectoryListHandlesOptionalParams

Parametri facoltativi.

DirectorySetMetadataHeaders

Definisce le intestazioni per l'operazione SetMetadata.

DirectorySetMetadataOptionalParams

Parametri facoltativi.

DirectorySetPropertiesHeaders

Definisce le intestazioni per l'operazione SetProperties.

DirectorySetPropertiesOptionalParams

Parametri facoltativi.

FileAbortCopyHeaders

Definisce le intestazioni per l'operazione AbortCopy.

FileAbortCopyOptionalParams

Parametri facoltativi.

FileCreateHeaders

Definisce le intestazioni per l'operazione di creazione.

FileCreateOptionalParams

Parametri facoltativi.

FileDeleteHeaders

Definisce le intestazioni per l'operazione Delete.

FileDeleteMethodOptionalParams

Parametri facoltativi.

FileDownloadHeaders

Definisce le intestazioni per l'operazione di download.

FileDownloadOptionalParams

Parametri facoltativi.

FileForceCloseHandlesHeaders

Definisce le intestazioni per l'operazione ForceCloseHandles.

FileForceCloseHandlesOptionalParams

Parametri facoltativi.

FileGetPropertiesHeaders

Definisce le intestazioni per l'operazione GetProperties.

FileGetPropertiesOptionalParams

Parametri facoltativi.

FileGetRangeListHeaders

Definisce le intestazioni per l'operazione GetRangeList.

FileGetRangeListOptionalParams

Parametri facoltativi.

FileHTTPHeaders

Parametri aggiuntivi per un set di operazioni, ad esempio: File_create, File_setHTTPHeaders.

FileItem

Elemento di file elencato.

FileListHandlesHeaders

Definisce le intestazioni per l'operazione ListHandles.

FileListHandlesOptionalParams

Parametri facoltativi.

FileProperty

Proprietà dei file.

FileSetHTTPHeadersHeaders

Definisce le intestazioni per l'operazione SetHTTPHeaders.

FileSetHTTPHeadersOptionalParams

Parametri facoltativi.

FileSetMetadataHeaders

Definisce le intestazioni per l'operazione SetMetadata.

FileSetMetadataOptionalParams

Parametri facoltativi.

FileStartCopyHeaders

Definisce le intestazioni per l'operazione StartCopy.

FileStartCopyOptionalParams

Parametri facoltativi.

FileUploadRangeFromURLHeaders

Definisce le intestazioni per l'operazione UploadRangeFromURL.

FileUploadRangeFromURLOptionalParams

Parametri facoltativi.

FileUploadRangeHeaders

Definisce le intestazioni per l'operazione UploadRange.

FileUploadRangeOptionalParams

Parametri facoltativi.

FilesAndDirectoriesListSegment

Astrazione per le voci che possono essere elencate da Directory.

HandleItem

Elemento dell'handle di Archiviazione di Azure elencato.

ListFilesAndDirectoriesSegmentResponse

Enumerazione di directory e file.

ListHandlesResponse

Enumerazione degli handle.

ListSharesResponse

Enumerazione delle condivisioni.

Metrics

Metriche di Analisi archiviazione per il servizio file.

Permission

Permission(a security descriptor) descritto in Security Descriptor Definition Language(SDDL).

Range

Intervallo di file di Archiviazione di Azure.

RetentionPolicy

Criteri di conservazione.

ServiceGetPropertiesHeaders

Definisce le intestazioni per l'operazione GetProperties.

ServiceGetPropertiesOptionalParams

Parametri facoltativi.

ServiceListSharesSegmentHeaders

Definisce le intestazioni per l'operazione ListSharesSegment.

ServiceListSharesSegmentOptionalParams

Parametri facoltativi.

ServiceSetPropertiesHeaders

Definisce le intestazioni per l'operazione SetProperties.

ServiceSetPropertiesOptionalParams

Parametri facoltativi.

ShareCreateHeaders

Definisce le intestazioni per l'operazione di creazione.

ShareCreateOptionalParams

Parametri facoltativi.

ShareCreatePermissionHeaders

Definisce le intestazioni per l'operazione CreatePermission.

ShareCreatePermissionOptionalParams

Parametri facoltativi.

ShareCreateSnapshotHeaders

Definisce le intestazioni per l'operazione CreateSnapshot.

ShareCreateSnapshotOptionalParams

Parametri facoltativi.

ShareDeleteHeaders

Definisce le intestazioni per l'operazione Delete.

ShareDeleteMethodOptionalParams

Parametri facoltativi.

ShareGetAccessPolicyHeaders

Definisce le intestazioni per l'operazione GetAccessPolicy.

ShareGetAccessPolicyOptionalParams

Parametri facoltativi.

ShareGetPermissionHeaders

Definisce le intestazioni per l'operazione GetPermission.

ShareGetPermissionOptionalParams

Parametri facoltativi.

ShareGetPropertiesHeaders

Definisce le intestazioni per l'operazione GetProperties.

ShareGetPropertiesOptionalParams

Parametri facoltativi.

ShareGetStatisticsHeaders

Definisce le intestazioni per l'operazione GetStatistics.

ShareGetStatisticsOptionalParams

Parametri facoltativi.

ShareItem

Elemento di condivisione di Archiviazione di Azure elencato.

ShareProperties

Proprietà di una condivisione.

ShareSetAccessPolicyHeaders

Definisce le intestazioni per l'operazione SetAccessPolicy.

ShareSetAccessPolicyOptionalParams

Parametri facoltativi.

ShareSetMetadataHeaders

Definisce le intestazioni per l'operazione SetMetadata.

ShareSetMetadataOptionalParams

Parametri facoltativi.

ShareSetQuotaHeaders

Definisce le intestazioni per l'operazione SetQuota.

ShareSetQuotaOptionalParams

Parametri facoltativi.

ShareStats

Statistiche per la condivisione.

SignedIdentifier

Identificatore firmato.

SourceModifiedAccessConditions

Parametri aggiuntivi per l'operazione uploadRangeFromURL.

StorageError

Interfaccia che rappresenta StorageError.

StorageServiceProperties

Proprietà del servizio di archiviazione.

IDownloadFromAzureFileOptions

Interfaccia dell'opzione per DownloadAzurefileToBuffer.

IUploadToAzureFileOptions

Interfaccia di opzione per uploadFileToAzureFile e uploadSeekableStreamToAzureFile.

IUploadStreamToAzureFileOptions

Interfaccia dell'opzione per uploadStreamToAzureFile.

IFileAndDirectoryCreateCommonOptions
IFileAndDirectorySetPropertiesCommonOptions
IFileHTTPHeaders
IMetadata
IRetriableReadableStreamOptions

Alias tipo

FileDownloadResponse

Contiene i dati di risposta per l'operazione di download.

FileGetRangeListResponse

Contiene i dati di risposta per l'operazione getRangeList.

ShareGetAccessPolicyResponse

Contiene i dati di risposta per l'operazione getAccessPolicy.

ShareGetStatisticsResponse

Contiene i dati di risposta per l'operazione getStatistics.

CredentialPolicyCreator

Funzione factory che crea un nuovo oggetto CredentialPolicy che usa nextPolicy fornito.

CopyStatusType

Definisce i valori per CopyStatusType. I valori possibili includono: 'in sospeso', 'success', 'aborted', 'failed'

DeleteSnapshotsOptionType

Definisce i valori per DeleteSnapshotsOptionType. I valori possibili includono: 'include'

DirectoryCreateResponse

Contiene i dati di risposta per l'operazione di creazione.

DirectoryDeleteResponse

Contiene i dati di risposta per l'operazione deleteMethod.

DirectoryForceCloseHandlesResponse

Contiene i dati di risposta per l'operazione forceCloseHandles.

DirectoryGetPropertiesResponse

Contiene i dati di risposta per l'operazione getProperties.

DirectoryListFilesAndDirectoriesSegmentResponse

Contiene i dati di risposta per l'operazione listFilesAndDirectoriesSegment.

DirectoryListHandlesResponse

Contiene i dati di risposta per l'operazione listHandles.

DirectorySetMetadataResponse

Contiene i dati di risposta per l'operazione setMetadata.

DirectorySetPropertiesResponse

Contiene i dati di risposta per l'operazione setProperties.

FileAbortCopyResponse

Contiene i dati di risposta per l'operazione abortCopy.

FileCreateResponse

Contiene i dati di risposta per l'operazione di creazione.

FileDeleteResponse

Contiene i dati di risposta per l'operazione deleteMethod.

FileForceCloseHandlesResponse

Contiene i dati di risposta per l'operazione forceCloseHandles.

FileGetPropertiesResponse

Contiene i dati di risposta per l'operazione getProperties.

FileListHandlesResponse

Contiene i dati di risposta per l'operazione listHandles.

FileRangeWriteType

Definisce i valori per FileRangeWriteType. I valori possibili includono: 'update', 'clear'

FileSetHTTPHeadersResponse

Contiene i dati di risposta per l'operazione setHTTPHeaders.

FileSetMetadataResponse

Contiene i dati di risposta per l'operazione setMetadata.

FileStartCopyResponse

Contiene i dati di risposta per l'operazione startCopy.

FileType

Definisce i valori per FileType. I valori possibili includono: 'File'

FileUploadRangeFromURLResponse

Contiene i dati di risposta per l'operazione uploadRangeFromURL.

FileUploadRangeResponse

Contiene i dati di risposta per l'operazione uploadRange.

ListSharesIncludeType

Definisce i valori per ListSharesIncludeType. I valori possibili includono: 'snapshot', 'metadata'

ServiceGetPropertiesResponse

Contiene i dati di risposta per l'operazione getProperties.

ServiceListSharesSegmentResponse

Contiene i dati di risposta per l'operazione listSharesSegment.

ServiceSetPropertiesResponse

Contiene i dati di risposta per l'operazione setProperties.

ShareCreatePermissionResponse

Contiene i dati di risposta per l'operazione createPermission.

ShareCreateResponse

Contiene i dati di risposta per l'operazione di creazione.

ShareCreateSnapshotResponse

Contiene i dati di risposta per l'operazione createSnapshot.

ShareDeleteResponse

Contiene i dati di risposta per l'operazione deleteMethod.

ShareGetPermissionResponse

Contiene i dati di risposta per l'operazione getPermission.

ShareGetPropertiesResponse

Contiene i dati di risposta per l'operazione getProperties.

ShareSetAccessPolicyResponse

Contiene i dati di risposta per l'operazione setAccessPolicy.

ShareSetMetadataResponse

Contiene i dati di risposta per l'operazione setMetadata.

ShareSetQuotaResponse

Contiene i dati di risposta per l'operazione setQuota.

StorageErrorCode

Definisce i valori per StorageErrorCode. I valori possibili includono: 'AccountAlreadyExists', 'AccountBeingCreated', 'AccountIsDisabled', 'AuthenticationFailed', 'AuthorizationFailure', 'ConditionHeadersNotSupported', 'ConditionNotMet', 'EmptyMetadataKey', 'InsufficientAccountPermissions', 'InternalError', 'InvalidAuthenticationInfo', 'InvalidHeaderValue', 'InvalidHttpVerb', 'InvalidInput', 'InvalidMd5', 'InvalidMetadata', 'InvalidQueryParameterValue', 'InvalidRange', 'InvalidResourceName', 'InvalidUri', ' InvalidXmlDocument', 'InvalidXmlNodeValue', 'Md5Mismatch', 'MetadataTooLarge', 'MissingContentLengthHeader', 'MissingRequiredQueryParameter', 'MissingRequiredHeader', 'MissingRequiredXmlNode', 'MultipleConditionHeadersNotSupported', 'OperationTimedOut', 'OutOfRangeInput', 'OutOfRangeQueryParameterValue', 'RequestBodyTooLarge', 'ResourceTypeMismatch', 'RequestUrlFailedToParse', 'ResourceAlreadyExists', 'ResourceNotFound', 'ServerBusy', 'UnsupportedHeader', ' UnsupportedXmlNode', 'UnsupportedQueryParameter', 'UnsupportedHttpVerb', 'CannotDeleteFileOrDirectory', 'ClientCacheFlushDelay', 'DeletePending', 'DirectoryNotEmpty', 'FileLockConflict', 'InvalidFileOrDirectoryPathName', 'ParentNotFound', 'ReadOnlyAttribute', 'ShareAlreadyExists', 'ShareBeingDeleted', 'ShareDisabled', 'ShareNotFound', 'SharingViolation', 'ShareSnapshotInProgress', 'ShareSnapshotCountExceeded', 'ShareSnapshotOperationNotSupported', ' ShareHasSnapshots', 'ContainerQuotaDowngradeNotAllowed'

FileAttributesPreserveType

Indica che gli attributi di file esistenti non sono stati modificati.

FilePermissionInheritType

Indica che eredita l'autorizzazione file dalla directory padre.

FilePermissionPreserveType

Indica che il valore dell'autorizzazione file esistente rimane invariato.

TimeNowType

Indica l'impostazione come ora della richiesta.

TimePreserveType

Indica che il valore dell'ora esistente rimane invariato.

Operation

L'operazione è una funzione asincrona da eseguire e gestire da Batch.

OutgoingHandler

OutgoingHandler è una funzione asincrona attivata da BufferScheduler.

ReadableStreamGetter

Enumerazioni

SASProtocol

Protocolli per la firma di accesso condiviso generato.

RetryPolicyType

Tipi RetryPolicy.

Funzioni

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

DISPONIBILE SOLO IN NODE.JS RUNTIME. Genera un oggetto <xref:SASQueryParameters> che contiene tutti i parametri di query sas necessari per effettuare una richiesta REST effettiva.

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

DISPONIBILE SOLO IN NODE.JS RUNTIME. Crea un'istanza di SASQueryParameters.

Accetta solo le impostazioni necessarie per creare una firma di accesso condiviso. Per le impostazioni facoltative, impostare direttamente le proprietà corrispondenti, ad esempio autorizzazioni, startTime e identificatore.

AVVISO: quando l'identificatore non viene fornito, sono necessarie autorizzazioni e expiryTime. È NECESSARIO assegnare un valore alle autorizzazioni di identificatore o expiryTime & manualmente se si esegue l'inizializzazione con questo costruttore.

ipRangeToString(IIPRange)

Generare la stringa di formato IPRange. Ad esempio: "8.8.8.8" o "1.1.1.1-255.255.255.255"

rangeToString(IRange)

Generare una stringa di intervallo. Ad esempio: "bytes=255-" o "bytes=0-511"

uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)

DISPONIBILE SOLO NEI BROWSER. Carica un oggetto BLOB/File/ArrayBuffer/ArrayBufferView del browser in un file di Azure.

downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)

DISPONIBILE SOLO IN NODE.JS RUNTIME. Scarica un file di Azure in parallelo in un buffer. Offset e conteggio sono facoltativi, passare 0 per entrambi per scaricare l'intero file.

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

DISPONIBILE SOLO IN NODE.JS RUNTIME. Carica un file locale in un file di Azure.

uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)

DISPONIBILE SOLO IN NODE.JS RUNTIME. Carica un flusso leggibile Node.js in un file di Azure. Questo metodo tenterà di creare un'istanza di Azure, quindi avvia il caricamento di blocchi per blocco. Le dimensioni del blocco sono definite dal parametro bufferSize. Assicurarsi che le dimensioni potenziali del flusso non superino le dimensioni del file.

SUGGERIMENTI PER IL MIGLIORAMENTO DELLE PRESTAZIONI:

  • L'highWaterMark del flusso di input è preferibile impostare lo stesso valore con il parametro bufferSize, che eviterà le operazioni Buffer.concat().
fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)
fileCreationTimeToString(Date | TimeNowType | TimePreserveType)
fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)
validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)
validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)
validateFilePermissionOptions(undefined | string, undefined | string)
NewRetryPolicyFactory(IRetryOptions)

Metodo factory usato per generare una factory RetryPolicy.

blobToArrayBuffer(Blob)

Convertire un oggetto BLOB del browser in ArrayBuffer.

appendToURLPath(string, string)

Aggiungere una stringa al percorso URL. Rimuoverà "/" duplicato davanti alla stringa quando il percorso URL termina con "/".

base64decode(string)

Decodifica Base64.

base64encode(string)

Codifica Base64.

delay(number, AbortSignalLike, Error)

Intervallo di tempo specificato in ritardo.

escapeURLPath(string)

I caratteri URL riservati devono essere preceduti correttamente da escape per i servizi di archiviazione, ad esempio BLOB o file.

Strategia di codifica e escape degli URL per gli SDK JSv10

Quando i clienti passano una stringa URL nel costruttore di classi XXXURL, la stringa URL potrebbe essere già codificata o meno. Ma prima di inviare al server di Archiviazione di Azure, l'URL deve essere codificato. Tuttavia, è difficile per un SDK indovinare se la stringa URL è stata codificata o meno. Abbiamo due strategie potenziali e abbiamo scelto la strategia due per i costruttori XXXURL.

Strategia 1: si supponga che la stringa URL del cliente non sia codificata e codifica sempre la stringa URL in SDK.

Questo è ciò che l'SDK V2 legacy fa, semplice e funziona per la maggior parte dei casi.

  • Quando la stringa dell'URL del cliente è "http://account.blob.core.windows.net/con/b:", l'SDK lo codifica in "http://account.blob.core.windows.net/con/b%3A" e inviare al server. Verrà creato un BLOB denominato "b:".
  • Quando la stringa dell'URL del cliente è "http://account.blob.core.windows.net/con/b%3A", l'SDK lo codifica in "http://account.blob.core.windows.net/con/b%253A" e inviare al server. Verrà creato un BLOB denominato "b%3A".

Ma questa strategia non consentirà di creare un BLOB con "?" nel nome. Poiché quando la stringa dell'URL del cliente è "http://account.blob.core.windows.net/con/blob?name", il "?name" verrà considerato come parametro URL anziché come nome BLOB. Se la stringa dell'URL del cliente è "http://account.blob.core.windows.net/con/blob%3Fname", verrà creato un BLOB denominato "BLOB%3Fname". V2 SDK non ha questo problema perché non consente al cliente di passare un URL completo, accetta un nome BLOB separato e encodeURIComponent. Non è possibile accettare un SDK per creare un nome BLOB con "?". Implementiamo quindi la strategia due:

Strategia 2: SDK non presuppone che l'URL sia stato codificato o meno. I caratteri speciali verranno semplicemente preceduti da escape.

Questo è il funzionamento di BLOB Go SDK V10.This is what what V10 Blob Go SDK does. Accetta un tipo di URL in Go e l'URL di chiamata. EscapedPath() per eseguire l'escape dei caratteri speciali senza caratteri.

  • Quando la stringa dell'URL del cliente è "http://account.blob.core.windows.net/con/b:", l'SDK eseguirà l'escape ":" come "http://account.blob.core.windows.net/con/b%3A" e inviare al server. Verrà creato un BLOB denominato "b:".
  • Quando la stringa dell'URL del cliente è "http://account.blob.core.windows.net/con/b%3A", non sono presenti caratteri speciali, quindi inviare "http://account.blob.core.windows.net/con/b%3A" al server. Verrà creato un BLOB denominato "b:".
  • Quando la stringa dell'URL del cliente è "http://account.blob.core.windows.net/con/b%253A", non sono presenti caratteri speciali, quindi inviare "http://account.blob.core.windows.net/con/b%253A" al server. Verrà creato un BLOB denominato "b%3A".

Questa strategia offre flessibilità per creare con qualsiasi carattere speciale. Ma "%" verrà considerato come un carattere speciale, se la stringa URL non è codificata, non dovrebbe essere presente un "%" nella stringa URL; in caso contrario, l'URL non è un URL valido. Se il cliente deve creare un BLOB con "%" nel nome del BLOB, usare "%25" insead di "%". Proprio come sopra il terzo campione. E le stringhe URL seguenti non sono valide:

  • "http://account.blob.core.windows.net/con/b%""
  • "http://account.blob.core.windows.net/con/b%2""
  • "http://account.blob.core.windows.net/con/b%G""

Un altro carattere speciale è "?", usare "%2F" per rappresentare un nome BLOB con "?" in una stringa URL.

Strategia per containerName, blobName o altri parametri XXXName specifici in metodi come BlobURL.fromContainerURL(containerURL, blobName)

Verrà applicata la strategia 1 e si chiamerà encodeURIComponent per questi parametri, ad esempio blobName. Poiché i clienti passano è un nome normale anziché un URL.

getURLParameter(string, string)

Ottenere il parametro URL in base al nome.

getURLPath(string)

Ottenere il percorso URL da una stringa URL.

getURLQueries(string)

Ottenere coppie chiave di query URL da una stringa URL.

padStart(string, number, undefined | string)

String.prototype.padStart()

setURLHost(string, string)

Impostare l'host URL.

setURLParameter(string, string, undefined | string)

Impostare il nome e il valore del parametro URL. Se il nome esiste nei parametri URL, il valore precedente verrà sostituito dalla chiave del nome. Se non si specifica un valore, il parametro verrà eliminato.

truncatedISO8061Date(Date, undefined | false | true)

Arrotonda una data disattivata in secondi.

streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)

Legge un flusso leggibile nel buffer. Riempire il buffer dall'offset alla fine.

Dettagli funzione

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

DISPONIBILE SOLO IN NODE.JS RUNTIME. Genera un oggetto <xref:SASQueryParameters> che contiene tutti i parametri di query sas necessari per effettuare una richiesta REST effettiva.

function generateAccountSASQueryParameters(accountSASSignatureValues: IAccountSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Parametri

accountSASSignatureValues
IAccountSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Restituisce

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

DISPONIBILE SOLO IN NODE.JS RUNTIME. Crea un'istanza di SASQueryParameters.

Accetta solo le impostazioni necessarie per creare una firma di accesso condiviso. Per le impostazioni facoltative, impostare direttamente le proprietà corrispondenti, ad esempio autorizzazioni, startTime e identificatore.

AVVISO: quando l'identificatore non viene fornito, sono necessarie autorizzazioni e expiryTime. È NECESSARIO assegnare un valore alle autorizzazioni di identificatore o expiryTime & manualmente se si esegue l'inizializzazione con questo costruttore.

function generateFileSASQueryParameters(fileSASSignatureValues: IFileSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Parametri

fileSASSignatureValues
IFileSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Restituisce

ipRangeToString(IIPRange)

Generare la stringa di formato IPRange. Ad esempio: "8.8.8.8" o "1.1.1.1-255.255.255.255"

function ipRangeToString(ipRange: IIPRange)

Parametri

ipRange
IIPRange

Restituisce

string

rangeToString(IRange)

Generare una stringa di intervallo. Ad esempio: "bytes=255-" o "bytes=0-511"

function rangeToString(iRange: IRange)

Parametri

iRange
IRange

Restituisce

string

uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)

DISPONIBILE SOLO NEI BROWSER. Carica un oggetto BLOB/File/ArrayBuffer/ArrayBufferView del browser in un file di Azure.

function uploadBrowserDataToAzureFile(aborter: Aborter, browserData: Blob | ArrayBuffer | ArrayBufferView, fileURL: FileURL, options?: IUploadToAzureFileOptions)

Parametri

aborter
Aborter

Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta

browserData

Blob | ArrayBuffer | ArrayBufferView

BLOB, File, ArrayBuffer o ArrayBufferView

fileURL
FileURL

Restituisce

Promise<void>

downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)

DISPONIBILE SOLO IN NODE.JS RUNTIME. Scarica un file di Azure in parallelo in un buffer. Offset e conteggio sono facoltativi, passare 0 per entrambi per scaricare l'intero file.

function downloadAzureFileToBuffer(aborter: Aborter, buffer: Buffer, fileURL: FileURL, offset: number, count?: undefined | number, options?: IDownloadFromAzureFileOptions)

Parametri

aborter
Aborter

Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta

buffer

Buffer

Il buffer da riempire deve avere una lunghezza maggiore del conteggio

fileURL
FileURL

Oggetto FileURL

offset

number

Da quale posizione del file di Azure scaricare

count

undefined | number

Restituisce

Promise<void>

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

DISPONIBILE SOLO IN NODE.JS RUNTIME. Carica un file locale in un file di Azure.

function uploadFileToAzureFile(aborter: Aborter, filePath: string, fileURL: FileURL, options?: IUploadToAzureFileOptions)

Parametri

aborter
Aborter

Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta

filePath

string

Percorso completo del file locale

fileURL
FileURL

FileURL

Restituisce

Promise<void>

uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)

DISPONIBILE SOLO IN NODE.JS RUNTIME. Carica un flusso leggibile Node.js in un file di Azure. Questo metodo tenterà di creare un'istanza di Azure, quindi avvia il caricamento di blocchi per blocco. Le dimensioni del blocco sono definite dal parametro bufferSize. Assicurarsi che le dimensioni potenziali del flusso non superino le dimensioni del file.

SUGGERIMENTI PER IL MIGLIORAMENTO DELLE PRESTAZIONI:

  • L'highWaterMark del flusso di input è preferibile impostare lo stesso valore con il parametro bufferSize, che eviterà le operazioni Buffer.concat().
function uploadStreamToAzureFile(aborter: Aborter, stream: Readable, size: number, fileURL: FileURL, bufferSize: number, maxBuffers: number, options?: IUploadStreamToAzureFileOptions)

Parametri

aborter
Aborter

Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta

stream

Readable

Node.js flusso leggibile. Deve essere minore o uguale alla dimensione del file.

size

number

Dimensioni del file da creare. La dimensione massima consentita è 1 TB. Se questo valore è maggiore delle dimensioni del flusso, nella parte finale del file saranno presenti byte vuoti.

fileURL
FileURL

Istanza di FileURL

bufferSize

number

Dimensioni di ogni buffer allocato in byte, anche le dimensioni del blocco/intervallo durante il file caricato. Le dimensioni devono essere > 0 e <= 4 * 1024 * 1024 (4 MB)

maxBuffers

number

Il numero massimo di buffer verrà allocato durante il caricamento, correlazione positiva con la concorrenza massima di caricamento

Restituisce

Promise<void>

fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)

function fileAttributesToString(fileAttributes: FileSystemAttributes | FileAttributesPreserveType)

Parametri

Restituisce

string

fileCreationTimeToString(Date | TimeNowType | TimePreserveType)

function fileCreationTimeToString(time: Date | TimeNowType | TimePreserveType)

Parametri

Restituisce

string

fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)

function fileLastWriteTimeToString(time: Date | TimeNowType | TimePreserveType)

Parametri

Restituisce

string

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)

function validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(options: IFileAndDirectoryCreateCommonOptions)

Parametri

Restituisce

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)

function validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(options: IFileAndDirectorySetPropertiesCommonOptions)

Parametri

Restituisce

validateFilePermissionOptions(undefined | string, undefined | string)

function validateFilePermissionOptions(filePermission?: undefined | string, filePermissionKey?: undefined | string)

Parametri

filePermission

undefined | string

filePermissionKey

undefined | string

NewRetryPolicyFactory(IRetryOptions)

Metodo factory usato per generare una factory RetryPolicy.

function NewRetryPolicyFactory(retryOptions?: IRetryOptions)

Parametri

retryOptions
IRetryOptions

Restituisce

RequestPolicyFactory

blobToArrayBuffer(Blob)

Convertire un oggetto BLOB del browser in ArrayBuffer.

function blobToArrayBuffer(blob: Blob)

Parametri

blob

Blob

Restituisce

Promise<ArrayBuffer>

appendToURLPath(string, string)

Aggiungere una stringa al percorso URL. Rimuoverà "/" duplicato davanti alla stringa quando il percorso URL termina con "/".

function appendToURLPath(url: string, name: string)

Parametri

url

string

Stringa URL di origine

name

string

Stringa da aggiungere all'URL

Restituisce

string

Stringa url aggiornata

base64decode(string)

Decodifica Base64.

function base64decode(encodedString: string)

Parametri

encodedString

string

Restituisce

string

base64encode(string)

Codifica Base64.

function base64encode(content: string)

Parametri

content

string

Restituisce

string

delay(number, AbortSignalLike, Error)

Intervallo di tempo specificato in ritardo.

function delay(timeInMs: number, aborter?: AbortSignalLike, abortError?: Error)

Parametri

timeInMs

number

aborter

AbortSignalLike

abortError

Error

Restituisce

Promise<unknown>

escapeURLPath(string)

I caratteri URL riservati devono essere preceduti correttamente da escape per i servizi di archiviazione, ad esempio BLOB o file.

Strategia di codifica e escape degli URL per gli SDK JSv10

Quando i clienti passano una stringa URL nel costruttore di classi XXXURL, la stringa URL potrebbe essere già codificata o meno. Ma prima di inviare al server di Archiviazione di Azure, l'URL deve essere codificato. Tuttavia, è difficile per un SDK indovinare se la stringa URL è stata codificata o meno. Abbiamo due strategie potenziali e abbiamo scelto la strategia due per i costruttori XXXURL.

Strategia 1: si supponga che la stringa URL del cliente non sia codificata e codifica sempre la stringa URL in SDK.

Questo è ciò che l'SDK V2 legacy fa, semplice e funziona per la maggior parte dei casi.

  • Quando la stringa dell'URL del cliente è "http://account.blob.core.windows.net/con/b:", l'SDK lo codifica in "http://account.blob.core.windows.net/con/b%3A" e inviare al server. Verrà creato un BLOB denominato "b:".
  • Quando la stringa dell'URL del cliente è "http://account.blob.core.windows.net/con/b%3A", l'SDK lo codifica in "http://account.blob.core.windows.net/con/b%253A" e inviare al server. Verrà creato un BLOB denominato "b%3A".

Ma questa strategia non consentirà di creare un BLOB con "?" nel nome. Poiché quando la stringa dell'URL del cliente è "http://account.blob.core.windows.net/con/blob?name", il "?name" verrà considerato come parametro URL anziché come nome BLOB. Se la stringa dell'URL del cliente è "http://account.blob.core.windows.net/con/blob%3Fname", verrà creato un BLOB denominato "BLOB%3Fname". V2 SDK non ha questo problema perché non consente al cliente di passare un URL completo, accetta un nome BLOB separato e encodeURIComponent. Non è possibile accettare un SDK per creare un nome BLOB con "?". Implementiamo quindi la strategia due:

Strategia 2: SDK non presuppone che l'URL sia stato codificato o meno. I caratteri speciali verranno semplicemente preceduti da escape.

Questo è il funzionamento di BLOB Go SDK V10.This is what what V10 Blob Go SDK does. Accetta un tipo di URL in Go e l'URL di chiamata. EscapedPath() per eseguire l'escape dei caratteri speciali senza caratteri.

  • Quando la stringa dell'URL del cliente è "http://account.blob.core.windows.net/con/b:", l'SDK eseguirà l'escape ":" come "http://account.blob.core.windows.net/con/b%3A" e inviare al server. Verrà creato un BLOB denominato "b:".
  • Quando la stringa dell'URL del cliente è "http://account.blob.core.windows.net/con/b%3A", non sono presenti caratteri speciali, quindi inviare "http://account.blob.core.windows.net/con/b%3A" al server. Verrà creato un BLOB denominato "b:".
  • Quando la stringa dell'URL del cliente è "http://account.blob.core.windows.net/con/b%253A", non sono presenti caratteri speciali, quindi inviare "http://account.blob.core.windows.net/con/b%253A" al server. Verrà creato un BLOB denominato "b%3A".

Questa strategia offre flessibilità per creare con qualsiasi carattere speciale. Ma "%" verrà considerato come un carattere speciale, se la stringa URL non è codificata, non dovrebbe essere presente un "%" nella stringa URL; in caso contrario, l'URL non è un URL valido. Se il cliente deve creare un BLOB con "%" nel nome del BLOB, usare "%25" insead di "%". Proprio come sopra il terzo campione. E le stringhe URL seguenti non sono valide:

  • "http://account.blob.core.windows.net/con/b%""
  • "http://account.blob.core.windows.net/con/b%2""
  • "http://account.blob.core.windows.net/con/b%G""

Un altro carattere speciale è "?", usare "%2F" per rappresentare un nome BLOB con "?" in una stringa URL.

Strategia per containerName, blobName o altri parametri XXXName specifici in metodi come BlobURL.fromContainerURL(containerURL, blobName)

Verrà applicata la strategia 1 e si chiamerà encodeURIComponent per questi parametri, ad esempio blobName. Poiché i clienti passano è un nome normale anziché un URL.

function escapeURLPath(url: string)

Parametri

url

string

Restituisce

string

getURLParameter(string, string)

Ottenere il parametro URL in base al nome.

function getURLParameter(url: string, name: string)

Parametri

url

string

name

string

Restituisce

string | string[] | undefined

getURLPath(string)

Ottenere il percorso URL da una stringa URL.

function getURLPath(url: string)

Parametri

url

string

Stringa URL di origine

Restituisce

string | undefined

getURLQueries(string)

Ottenere coppie chiave di query URL da una stringa URL.

function getURLQueries(url: string)

Parametri

url

string

Restituisce

[key: string]: string

padStart(string, number, undefined | string)

String.prototype.padStart()

function padStart(currentString: string, targetLength: number, padString?: undefined | string)

Parametri

currentString

string

targetLength

number

padString

undefined | string

Restituisce

string

setURLHost(string, string)

Impostare l'host URL.

function setURLHost(url: string, host: string)

Parametri

url

string

Stringa URL di origine

host

string

Nuova stringa host

Restituisce

string

Stringa url aggiornata

setURLParameter(string, string, undefined | string)

Impostare il nome e il valore del parametro URL. Se il nome esiste nei parametri URL, il valore precedente verrà sostituito dalla chiave del nome. Se non si specifica un valore, il parametro verrà eliminato.

function setURLParameter(url: string, name: string, value?: undefined | string)

Parametri

url

string

Stringa URL di origine

name

string

Nome parametro

value

undefined | string

Restituisce

string

Stringa url aggiornata

truncatedISO8061Date(Date, undefined | false | true)

Arrotonda una data disattivata in secondi.

function truncatedISO8061Date(date: Date, withMilliseconds?: undefined | false | true)

Parametri

date

Date

withMilliseconds

undefined | false | true

Restituisce

string

Stringa di data in formato ISO8061, con o senza componente di 7 millisecondi

streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)

Legge un flusso leggibile nel buffer. Riempire il buffer dall'offset alla fine.

function streamToBuffer(stream: ReadableStream, buffer: Buffer, offset: number, end: number, encoding?: undefined | string)

Parametri

stream

ReadableStream

Flusso leggibile Node.js

buffer

Buffer

Buffer da riempire, la lunghezza deve >= offset

offset

number

Da quale posizione nel buffer da riempire, inclusiva

end

number

In cui posizionare il buffer da riempire, esclusivo

encoding

undefined | string

Restituisce

Promise<void>