Dela via

@azure/storage-file package

Klasser

Aborter

En aborterinstans implementerar AbortSignal-gränssnittet, kan avbryta HTTP-begäranden.

  • Anropa Aborter.none för att skapa en ny Aborter-instans utan timeout.
  • Anropa Aborter.timeout() för att skapa en ny Aborter-instans med timeout.

För en befintlig instans aborter:

  • Anropa aborter.withTimeout() för att skapa och returnera en underordnad Aborter-instans med timeout.
  • Anropa aborter.withValue(key, value) för att skapa och returnera en underordnad Aborter-instans med nyckel/värde-par.
  • Anropa aborter.abort() för att avbryta den aktuella instansen och alla underordnade instanser.
  • Anropa aborter.getValue(key) för att söka efter och hämta värde med motsvarande nyckel från aktuell aborter till alla överordnade.
AccountSASPermissions

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att konstruera en sträng som representerar de behörigheter som beviljas av en AccountSAS. Om ett värde anges till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfältet på ett <xref:IAccountSASSignatureValues> objekt. Det går att konstruera behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet.
AccountSASResourceTypes

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att konstruera en sträng som representerar de resurser som är tillgängliga för en AccountSAS. Om du anger värdet true innebär det att alla SAS som använder dessa behörigheter ger åtkomst till den resurstypen. När alla värden har angetts ska detta serialiseras med toString och anges som resursfält i ett <xref:IAccountSASSignatureValues>-objekt. Det går att konstruera resurssträngen utan den här klassen, men resursordningen är speciell och den här klassen garanterar korrekthet.
AccountSASServices

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att konstruera en sträng som representerar de tjänster som är tillgängliga för en AccountSAS. Om du anger värdet true innebär det att alla SAS som använder dessa behörigheter ger åtkomst till den tjänsten. När alla värden har angetts ska detta serialiseras med toString och anges som tjänstfältet på ett <xref:IAccountSASSignatureValues> objekt. Det går att konstruera tjänstesträngen utan den här klassen, men ordningen på tjänsterna är speciell och den här klassen garanterar korrekthet.
BrowserPolicyFactory

BrowserPolicyFactory är en fabriksklass som hjälper till att generera BrowserPolicy-objekt.
DirectoryURL

En DirectoryURL representerar en URL till Azure Storage-katalogen så att du kan ändra dess filer och kataloger.
FileSASPermissions

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Det här är en hjälpklass för att konstruera en sträng som representerar de behörigheter som beviljas av en ServiceSAS till en fil. Om ett värde anges till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfältet på ett <xref:IFileSASSignatureValues> objekt. Det går att konstruera behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet.
FileSystemAttributes

Det här är en hjälpklass för att konstruera en sträng som representerar NTFS-attributen till en fil eller katalog.
FileURL

En FileURL representerar en URL till en Azure Storage-fil.
KeepAlivePolicyFactory

KeepAlivePolicyFactory är en fabriksklass som hjälper till att generera KeepAlivePolicy-objekt.
LoggingPolicyFactory

LoggingPolicyFactory är en fabriksklass som hjälper till att generera LoggingPolicy-objekt.
Pipeline

En Pipeline-klass som innehåller HTTP-begärandeprinciper. Du kan skapa en standardpipeline genom att anropa StorageURL.newPipeline(). Eller så kan du skapa en pipeline med dina egna principer av konstruktorn för Pipeline. Se StorageURL.newPipeline() och tillhandahållna principer som referens innan du implementerar din anpassade pipeline.
RetryPolicyFactory

RetryPolicyFactory är en fabriksklass som hjälper till att generera RetryPolicy-objekt.
SASQueryParameters

Representerar de komponenter som utgör en Azure Storage SAS-frågeparametrar. Den här typen skapas inte direkt av användaren. Den genereras endast av <xref:IAccountSASSignatureValues>- och <xref:IFileSASSignatureValues>-typerna. När den har genererats kan den kodas till en {@code String} och läggas till i en URL direkt (även om försiktighet bör vidtas här om det finns befintliga frågeparametrar, vilket kan påverka lämpliga sätt att lägga till dessa frågeparametrar). Obs! Instanser av den här klassen är oföränderliga.
ServiceURL

En ServiceURL representerar en URL till Azure Storage File-tjänsten så att du kan ändra filresurser.
ShareSASPermissions

Det här är en hjälpklass för att konstruera en sträng som representerar de behörigheter som beviljas av en ServiceSAS till en resurs. Om ett värde anges till true innebär det att alla SAS som använder dessa behörigheter beviljar behörigheter för åtgärden. När alla värden har angetts ska detta serialiseras med toString och anges som behörighetsfältet på ett <xref:IFileSASSignatureValues> objekt. Det går att konstruera behörighetssträngen utan den här klassen, men behörigheternas ordning är speciell och den här klassen garanterar korrekthet.
ShareURL

En ShareURL representerar en URL till Azure Storage-resursen så att du kan ändra dess kataloger och filer.
StorageURL

En ServiceURL representerar en baserad URL-klass för ServiceURL, ContainerURL och så vidare.
TelemetryPolicyFactory

TelemetryPolicyFactory är en fabriksklass som hjälper till att generera TelemetryPolicy-objekt.
UniqueRequestIDPolicyFactory

UniqueRequestIDPolicyFactory är en fabriksklass som hjälper till att generera UniqueRequestIDPolicy-objekt.
AnonymousCredential

AnonymousCredential tillhandahåller en credentialPolicyCreator-medlem som används för att skapa AnonymousCredentialPolicy-objekt. AnonymousCredentialPolicy används med HTTP-begäranden som läser offentliga resurser eller för användning med signaturer för delad åtkomst (SAS).
Credential

Autentiseringsuppgifter är en abstrakt klass för signering av HTTP-begäranden i Azure Storage. Den här klassen är värd för en credentialPolicyCreator-fabrik som genererar CredentialPolicy.
SharedKeyCredential

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. SharedKeyCredential för kontonyckelauktorisering av Azure Storage-tjänsten.
Directory

Klass som representerar en katalog.
File

Klass som representerar en fil.
Service

Klass som representerar en tjänst.
Share

Klass som representerar en resurs.
StorageClient
StorageClientContext
AnonymousCredentialPolicy

AnonymousCredentialPolicy används med HTTP-begäranden som läser offentliga resurser eller för användning med signaturer för delad åtkomst (SAS).
BrowserPolicy

BrowserPolicy hanterar skillnader mellan Node.js och webbläsarkörning, inklusive:

  1. Webbläsare cachelagrar GET/HEAD-begäranden genom att lägga till villkorsstyrda rubriker som "IF_MODIFIED_SINCE". BrowserPolicy är en princip som används för att lägga till en tidsstämpelfråga i GET/HEAD-begärande-URL:en och därmed undvika webbläsarens cacheminne.

  2. Ta bort cookierubrik för säkerhet

  3. Ta bort innehållslängdsrubrik för att undvika webbläsarvarningar
CredentialPolicy

Princip för autentiseringsuppgifter som används för att signera HTTP-begäranden (S) innan de skickas. Det här är en abstrakt klass.
KeepAlivePolicy

KeepAlivePolicy är en princip som används för att styra keep alive-inställningar för varje begäran.
LoggingPolicy

LoggingPolicy är en princip som används för att logga begäranden.
RetryPolicy

Återförsöksprincip med exponentiellt återförsök och linjärt återförsök implementerat.
SharedKeyCredentialPolicy

SharedKeyCredentialPolicy är en princip som används för att signera HTTP-begäran med en delad nyckel.
TelemetryPolicy

TelemetryPolicy är en princip som används för att tagga användaragenthuvud för varje begäran.
UniqueRequestIDPolicy

UniqueRequestIDPolicy genererar ett UUID som x-ms-request-id-huvudvärde.
Batch

Batch tillhandahåller grundläggande parallell körning med samtidighetsgränser. Stoppar körningen av vänsteråtgärder när en av de utförda åtgärderna utlöser ett fel. Men Batch kan inte avbryta pågående åtgärder. Du måste avbryta dem själv.
BufferScheduler

Den här klassen accepterar en Node.js läsbar ström som indata och fortsätter att läsa data från strömmen till den interna buffertstrukturen tills den når maxBuffers. Varje tillgänglig buffert försöker utlösa outgoingHandler. Den interna buffertstrukturen innehåller en inkommande buffertmatris och en utgående buffertmatris. Den inkommande buffertmatrisen innehåller "tomma" buffertar som kan fyllas med nya inkommande data. Den utgående matrisen innehåller de fyllda buffertar som ska hanteras av outgoingHandler. Varje buffertstorlek ovan definieras av parameterbuffertStorlek.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

<NUM_OF_ALL_BUFFERS = maxBuffers

TIPS FÖR PRESTANDAFÖRBÄTTRING:

  1. HighWaterMark för indataström är bättre att ange samma värde med bufferSize-parametern, vilket undviker buffer.concat()-åtgärder.
  2. Parallellitet bör ange ett mindre värde än maxBuffers, vilket är användbart för att minska risken när en utgående hanterare väntar på dataströmmen. I det här fallet blockeras utgående hanterare. Utgående kö ska inte vara tom.
RetriableReadableStream

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. En Node.js ReadableStream försöker internt igen när det interna ReadableStream-oväntade slutar.

Gränssnitt

IDirectoryCreateOptions
IDirectoryForceCloseHandlesSegmentOptions
IDirectoryListFilesAndDirectoriesSegmentOptions
IDirectoryListHandlesSegmentOptions
IDirectoryProperties
IFileCreateOptions
IFileDownloadOptions
IFileGetRangeListOptions

Alternativet definieras som paritet till REST-definition. Även om det inte är redo att användas nu, är crc64 av källinnehåll inte tillgängligt.
IFileListHandlesSegmentOptions
IFileProperties
IFileStartCopyOptions
IFileUploadRangeOptions
ISetPropertiesResponse
IAccountSASSignatureValues

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. IAccountSASSignatureValues används för att generera en signatur för delad åtkomst (SAS) för ett Azure Storage-konto. När alla värden här har angetts på rätt sätt anrop genererar anropetSASQueryParameters() för att hämta en representation av SAS som faktiskt kan tillämpas på fil-URL:er. Obs! Att både den här klassen och <xref:SASQueryParameters> finns eftersom den förra är föränderlig och en logisk representation medan den senare är oföränderlig och används för att generera faktiska REST-begäranden.
IFileSASSignatureValues

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. IFileSASSignatureValues används för att generera SAS-token för filtjänsten för resurser eller filer.
IIPRange

Tillåtna IP-intervall för en SAS.
IRange

Intervall för tjänståtgärder.
IKeepAliveOptions

Gränssnitt för KeepAlivePolicy-alternativ.
IRequestLogOptions

RequestLogOptions konfigurerar återförsöksprincipens beteende.
IPipelineOptions

Alternativgränssnitt för pipelinekonstruktor.
IRetryOptions

Gränssnitt för återförsöksalternativ.
IServiceListSharesSegmentOptions
IShareCreateOptions
IShareCreateSnapshotOptions
IShareDeleteMethodOptions
ISignedIdentifier
INewPipelineOptions

Alternativgränssnitt för Pipeline.newPipeline-metoden.
ITelemetryOptions

Gränssnitt för alternativ för TelemetryPolicy.
AccessPolicy

En åtkomstprincip.
CorsRule

CORS är en HTTP-funktion som gör att ett webbprogram som körs under en domän kan komma åt resurser i en annan domän. Webbläsare implementerar en säkerhetsbegränsning som kallas samma ursprungsprincip som förhindrar att en webbsida anropar API:er i en annan domän. CORS är ett säkert sätt att tillåta att en domän (ursprungsdomänen) anropar API:er i en annan domän.
DirectoryCreateHeaders

Definierar rubriker för åtgärden Skapa.
DirectoryCreateOptionalParams

Valfria parametrar.
DirectoryDeleteHeaders

Definierar rubriker för borttagningsåtgärden.
DirectoryDeleteMethodOptionalParams

Valfria parametrar.
DirectoryForceCloseHandlesHeaders

Definierar rubriker för ForceCloseHandles-åtgärden.
DirectoryForceCloseHandlesOptionalParams

Valfria parametrar.
DirectoryGetPropertiesHeaders

Definierar rubriker för åtgärden GetProperties.
DirectoryGetPropertiesOptionalParams

Valfria parametrar.
DirectoryItem

Ett katalogobjekt i listan.
DirectoryListFilesAndDirectoriesSegmentHeaders

Definierar rubriker för åtgärden ListFilesAndDirectoriesSegment.
DirectoryListFilesAndDirectoriesSegmentOptionalParams

Valfria parametrar.
DirectoryListHandlesHeaders

Definierar rubriker för ListHandles-åtgärden.
DirectoryListHandlesOptionalParams

Valfria parametrar.
DirectorySetMetadataHeaders

Definierar rubriker för Åtgärden SetMetadata.
DirectorySetMetadataOptionalParams

Valfria parametrar.
DirectorySetPropertiesHeaders

Definierar rubriker för Åtgärden SetProperties.
DirectorySetPropertiesOptionalParams

Valfria parametrar.
FileAbortCopyHeaders

Definierar rubriker för AbortCopy-åtgärden.
FileAbortCopyOptionalParams

Valfria parametrar.
FileCreateHeaders

Definierar rubriker för åtgärden Skapa.
FileCreateOptionalParams

Valfria parametrar.
FileDeleteHeaders

Definierar rubriker för borttagningsåtgärden.
FileDeleteMethodOptionalParams

Valfria parametrar.
FileDownloadHeaders

Definierar rubriker för nedladdningsåtgärden.
FileDownloadOptionalParams

Valfria parametrar.
FileForceCloseHandlesHeaders

Definierar rubriker för ForceCloseHandles-åtgärden.
FileForceCloseHandlesOptionalParams

Valfria parametrar.
FileGetPropertiesHeaders

Definierar rubriker för åtgärden GetProperties.
FileGetPropertiesOptionalParams

Valfria parametrar.
FileGetRangeListHeaders

Definierar rubriker för åtgärden GetRangeList.
FileGetRangeListOptionalParams

Valfria parametrar.
FileHTTPHeaders

Ytterligare parametrar för en uppsättning åtgärder, till exempel: File_create, File_setHTTPHeaders.
FileItem

Ett angivet filobjekt.
FileListHandlesHeaders

Definierar rubriker för ListHandles-åtgärden.
FileListHandlesOptionalParams

Valfria parametrar.
FileProperty

Filegenskaper.
FileSetHTTPHeadersHeaders

Definierar rubriker för SetHTTPHeaders-åtgärden.
FileSetHTTPHeadersOptionalParams

Valfria parametrar.
FileSetMetadataHeaders

Definierar rubriker för Åtgärden SetMetadata.
FileSetMetadataOptionalParams

Valfria parametrar.
FileStartCopyHeaders

Definierar rubriker för StartCopy-åtgärden.
FileStartCopyOptionalParams

Valfria parametrar.
FileUploadRangeFromURLHeaders

Definierar rubriker för UploadRangeFromURL-åtgärden.
FileUploadRangeFromURLOptionalParams

Valfria parametrar.
FileUploadRangeHeaders

Definierar rubriker för uploadrange-åtgärden.
FileUploadRangeOptionalParams

Valfria parametrar.
FilesAndDirectoriesListSegment

Abstrakt för poster som kan visas i katalogen.
HandleItem

Ett azure storage-referensobjekt i listan.
ListFilesAndDirectoriesSegmentResponse

En uppräkning av kataloger och filer.
ListHandlesResponse

En uppräkning av referenser.
ListSharesResponse

En uppräkning av resurser.
Metrics

Mått för Lagringsanalys för filtjänsten.
Permission

Behörighet (en säkerhetsbeskrivning) som beskrivs i SDDL (Security Descriptor Definition Language).
Range

Ett Azure Storage-filintervall.
RetentionPolicy

Kvarhållningsprincipen.
ServiceGetPropertiesHeaders

Definierar rubriker för åtgärden GetProperties.
ServiceGetPropertiesOptionalParams

Valfria parametrar.
ServiceListSharesSegmentHeaders

Definierar rubriker för åtgärden ListSharesSegment.
ServiceListSharesSegmentOptionalParams

Valfria parametrar.
ServiceSetPropertiesHeaders

Definierar rubriker för Åtgärden SetProperties.
ServiceSetPropertiesOptionalParams

Valfria parametrar.
ShareCreateHeaders

Definierar rubriker för åtgärden Skapa.
ShareCreateOptionalParams

Valfria parametrar.
ShareCreatePermissionHeaders

Definierar rubriker för åtgärden CreatePermission.
ShareCreatePermissionOptionalParams

Valfria parametrar.
ShareCreateSnapshotHeaders

Definierar rubriker för åtgärden CreateSnapshot.
ShareCreateSnapshotOptionalParams

Valfria parametrar.
ShareDeleteHeaders

Definierar rubriker för borttagningsåtgärden.
ShareDeleteMethodOptionalParams

Valfria parametrar.
ShareGetAccessPolicyHeaders

Definierar rubriker för åtgärden GetAccessPolicy.
ShareGetAccessPolicyOptionalParams

Valfria parametrar.
ShareGetPermissionHeaders

Definierar rubriker för GetPermission-åtgärden.
ShareGetPermissionOptionalParams

Valfria parametrar.
ShareGetPropertiesHeaders

Definierar rubriker för åtgärden GetProperties.
ShareGetPropertiesOptionalParams

Valfria parametrar.
ShareGetStatisticsHeaders

Definierar rubriker för GetStatistics-åtgärden.
ShareGetStatisticsOptionalParams

Valfria parametrar.
ShareItem

Ett listat Azure Storage-resursobjekt.
ShareProperties

Egenskaper för en resurs.
ShareSetAccessPolicyHeaders

Definierar rubriker för Åtgärden SetAccessPolicy.
ShareSetAccessPolicyOptionalParams

Valfria parametrar.
ShareSetMetadataHeaders

Definierar rubriker för Åtgärden SetMetadata.
ShareSetMetadataOptionalParams

Valfria parametrar.
ShareSetQuotaHeaders

Definierar rubriker för SetQuota-åtgärden.
ShareSetQuotaOptionalParams

Valfria parametrar.
ShareStats

Statistik för aktien.
SignedIdentifier

Signerad identifierare.
SourceModifiedAccessConditions

Ytterligare parametrar för uploadRangeFromURL-åtgärd.
StorageError

Ett gränssnitt som representerar StorageError.
StorageServiceProperties

Egenskaper för lagringstjänsten.
IDownloadFromAzureFileOptions

Alternativgränssnitt för DownloadAzurefileToBuffer.
IUploadToAzureFileOptions

Alternativgränssnitt för uploadFileToAzureFile och uploadSeekableStreamToAzureFile.
IUploadStreamToAzureFileOptions

Alternativgränssnitt för uploadStreamToAzureFile.
IFileAndDirectoryCreateCommonOptions
IFileAndDirectorySetPropertiesCommonOptions
IFileHTTPHeaders
IMetadata
IRetriableReadableStreamOptions

Typalias

FileDownloadResponse

Innehåller svarsdata för nedladdningsåtgärden.
FileGetRangeListResponse

Innehåller svarsdata för åtgärden getRangeList.
ShareGetAccessPolicyResponse

Innehåller svarsdata för åtgärden getAccessPolicy.
ShareGetStatisticsResponse

Innehåller svarsdata för åtgärden getStatistics.
CredentialPolicyCreator

En fabriksfunktion som skapar en ny CredentialPolicy som använder den angivna nextPolicy.
CopyStatusType

Definierar värden för CopyStatusType. Möjliga värden är: "väntande", "lyckades", "avbröts", "misslyckades"
DeleteSnapshotsOptionType

Definierar värden för DeleteSnapshotsOptionType. Möjliga värden är: "include"
DirectoryCreateResponse

Innehåller svarsdata för skapandeåtgärden.
DirectoryDeleteResponse

Innehåller svarsdata för åtgärden deleteMethod.
DirectoryForceCloseHandlesResponse

Innehåller svarsdata för forceCloseHandles-åtgärden.
DirectoryGetPropertiesResponse

Innehåller svarsdata för åtgärden getProperties.
DirectoryListFilesAndDirectoriesSegmentResponse

Innehåller svarsdata för åtgärden listFilesAndDirectoriesSegment.
DirectoryListHandlesResponse

Innehåller svarsdata för listHandles-åtgärden.
DirectorySetMetadataResponse

Innehåller svarsdata för setMetadata-åtgärden.
DirectorySetPropertiesResponse

Innehåller svarsdata för åtgärden setProperties.
FileAbortCopyResponse

Innehåller svarsdata för abortCopy-åtgärden.
FileCreateResponse

Innehåller svarsdata för skapandeåtgärden.
FileDeleteResponse

Innehåller svarsdata för åtgärden deleteMethod.
FileForceCloseHandlesResponse

Innehåller svarsdata för forceCloseHandles-åtgärden.
FileGetPropertiesResponse

Innehåller svarsdata för åtgärden getProperties.
FileListHandlesResponse

Innehåller svarsdata för listHandles-åtgärden.
FileRangeWriteType

Definierar värden för FileRangeWriteType. Möjliga värden är: "update", "clear"
FileSetHTTPHeadersResponse

Innehåller svarsdata för åtgärden setHTTPHeaders.
FileSetMetadataResponse

Innehåller svarsdata för setMetadata-åtgärden.
FileStartCopyResponse

Innehåller svarsdata för startCopy-åtgärden.
FileType

Definierar värden för FileType. Möjliga värden är: "File"
FileUploadRangeFromURLResponse

Innehåller svarsdata för åtgärden uploadRangeFromURL.
FileUploadRangeResponse

Innehåller svarsdata för uploadRange-åtgärden.
ListSharesIncludeType

Definierar värden för ListSharesIncludeType. Möjliga värden är: "snapshots", "metadata"
ServiceGetPropertiesResponse

Innehåller svarsdata för åtgärden getProperties.
ServiceListSharesSegmentResponse

Innehåller svarsdata för åtgärden listSharesSegment.
ServiceSetPropertiesResponse

Innehåller svarsdata för åtgärden setProperties.
ShareCreatePermissionResponse

Innehåller svarsdata för åtgärden createPermission.
ShareCreateResponse

Innehåller svarsdata för skapandeåtgärden.
ShareCreateSnapshotResponse

Innehåller svarsdata för åtgärden createSnapshot.
ShareDeleteResponse

Innehåller svarsdata för åtgärden deleteMethod.
ShareGetPermissionResponse

Innehåller svarsdata för åtgärden getPermission.
ShareGetPropertiesResponse

Innehåller svarsdata för åtgärden getProperties.
ShareSetAccessPolicyResponse

Innehåller svarsdata för setAccessPolicy-åtgärden.
ShareSetMetadataResponse

Innehåller svarsdata för setMetadata-åtgärden.
ShareSetQuotaResponse

Innehåller svarsdata för setQuota-åtgärden.
StorageErrorCode

Definierar värden för StorageErrorCode. Möjliga värden är: "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", " Stöds inteXmlNode, "UnsupportedQueryParameter", "UnsupportedHttpVerb", "CannotDeleteFileOrDirectory", "ClientCacheFlushDelay", "DeletePending", "DirectoryNotEmpty", "FileLockConflict", "InvalidFileOrDirectoryPathName", "ParentNotFound", "ReadOnlyAttribute", "ShareAlreadyExists", "ShareBeingDeleted", "ShareDisabled", "ShareNotFound", "SharingViolation", "ShareSnapshotInProgress", "ShareSnapshotCountExceededed", "ShareSnapshotOperationNotSupported", " ShareHasSnapshots, "ContainerQuotaDowngradeNotAllowed"
FileAttributesPreserveType

Anger att befintliga filattribut ska vara oförändrade.
FilePermissionInheritType

Anger ärvd filbehörighet från den överordnade katalogen.
FilePermissionPreserveType

Anger att det befintliga filbehörighetsvärdet ska vara oförändrat.
TimeNowType

Anger inställningen som tidpunkten för begäran.
TimePreserveType

Anger att det befintliga tidsvärdet ska vara oförändrat.
Operation

Åtgärden är en asynkron funktion som ska köras och hanteras av Batch.
OutgoingHandler

OutgoingHandler är en asynkron funktion som utlöses av BufferScheduler.
ReadableStreamGetter

Uppräkningar

SASProtocol

Protokoll för genererad SAS.
RetryPolicyType

RetryPolicy-typer.

Funktioner

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Genererar ett <xref:SASQueryParameters> objekt som innehåller alla SAS-frågeparametrar som behövs för att göra en faktisk REST-begäran.
generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Skapar en instans av SASQueryParameters.

Accepterar endast nödvändiga inställningar som krävs för att skapa en SAS. För valfria inställningar anger du motsvarande egenskaper direkt, till exempel behörigheter, startTime och identifierare.

VARNING! När identifieraren inte har angetts krävs behörigheter och expiryTime. Du MÅSTE tilldela värdet till identifieraren eller expiryTime & behörigheter manuellt om du börjar med den här konstruktorn.
ipRangeToString(IIPRange)

Generera IPRange-formatsträng. Exempel: "8.8.8.8.8" eller "1.1.1.1-255.255.255.255"
rangeToString(IRange)

Generera en intervallsträng. Till exempel: "bytes=255-" eller "bytes=0-511"
uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)

ENDAST TILLGÄNGLIGT I WEBBLÄSARE. Laddar upp ett blob-/fil-/matrisbuffer-/ArrayBufferView-objekt i webbläsaren till en Azure-fil.
downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure-fil parallellt med en buffert. Förskjutning och antal är valfria, skicka 0 för att båda ska kunna ladda ned hela filen.
uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar upp en lokal fil till en Azure-fil.
uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar upp en Node.js läsbar dataström till en Azure-fil. Den här metoden försöker skapa en Azure och börjar sedan ladda upp segment för segment. Storleken på segment definieras av bufferSize parameter. Kontrollera att den potentiella storleken på dataströmmen inte överskrider filstorleken.

TIPS FÖR PRESTANDAFÖRBÄTTRING:

  • HighWaterMark för indataström är bättre att ange samma värde med bufferSize-parametern, vilket undviker buffer.concat()-åtgärder.
fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)
fileCreationTimeToString(Date | TimeNowType | TimePreserveType)
fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)
validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)
validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)
validateFilePermissionOptions(undefined | string, undefined | string)
NewRetryPolicyFactory(IRetryOptions)

En fabriksmetod som används för att generera en RetryPolicy-fabrik.
blobToArrayBuffer(Blob)

Konvertera ett webbläsarblobobjekt till ArrayBuffer.
appendToURLPath(string, string)

Lägg till en sträng i URL-sökvägen. Tar bort duplicerade "/" framför strängen när URL-sökvägen slutar med "/".
base64decode(string)

Base64-avkodning.
base64encode(string)

Base64-kodning.
delay(number, AbortSignalLike, Error)

Fördröj angivet tidsintervall.
escapeURLPath(string)

Reserverade URL-tecken måste vara korrekt undantagna för lagringstjänster som Blob eller File.

URL-kodning och escape-strategi för JSv10 SDK:er

När kunder skickar en URL-sträng till konstruktorn XXXURL-klasser kan URL-strängen redan vara URL-kodad eller inte. Men innan du skickar till Azure Storage-servern måste URL:en kodas. Det är dock svårt för en SDK att gissa om URL-strängen har kodats eller inte. Vi har två potentiella strategier och valde strategi två för XXXURL-konstruktorerna.

Strategi ett: Anta att kundens URL-sträng inte är kodad och alltid kodar URL-strängen i SDK.

Det här är vad äldre V2 SDK gör, enkelt och fungerar för de flesta av fallen.

  • När kundens URL-sträng är "http://account.blob.core.windows.net/con/b:", kodar SDK den till "http://account.blob.core.windows.net/con/b%3A" och skicka till servern. En blob med namnet "b:" skapas.
  • När kundens URL-sträng är "http://account.blob.core.windows.net/con/b%3A", kodar SDK den till "http://account.blob.core.windows.net/con/b%253A" och skicka till servern. En blob med namnet "b%3A" skapas.

Men den här strategin gör det inte möjligt att skapa en blob med "?" i dess namn. För när kundens URL-sträng är "http://account.blob.core.windows.net/con/blob?name", behandlas "?name" som URL-paramter i stället för blobnamn. Om kundens URL-sträng ärhttp://account.blob.core.windows.net/con/blob%3Fname"skapas en blob med namnet "blob%3Fname". V2 SDK har inte det här problemet eftersom det inte tillåter att kunden skickar en fullständig URL. Det accepterar ett separat blobnamn och encodeURIComponent för det. Vi kan inte acceptera att ett SDK inte kan skapa ett blobnamn med "?". Så vi implementerar strategi två:

Strategi två: SDK förutsätter inte att URL:en har kodats eller inte. Det kommer bara att undkomma specialtecken.

Detta är vad V10 Blob Go SDK gör. Den accepterar en URL-typ i Go och anropar URL. EscapePath() för att undkomma de speciella tecken som inte är kapslade.

  • När kundens URL-sträng är "http://account.blob.core.windows.net/con/b:", kommer SDK att fly ":" som "http://account.blob.core.windows.net/con/b%3A" och skicka till servern. En blob med namnet "b:" skapas.
  • När kundens URL-sträng är "http://account.blob.core.windows.net/con/b%3A", finns det inga specialtecken, så skicka "http://account.blob.core.windows.net/con/b%3A" till servern. En blob med namnet "b:" skapas.
  • När kundens URL-sträng är "http://account.blob.core.windows.net/con/b%253A", finns det inga specialtecken, så skicka "http://account.blob.core.windows.net/con/b%253A" till servern. En blob med namnet "b%3A" skapas.

Den här strategin ger oss flexibilitet att skapa med specialtecken. Men "%" behandlas som specialtecken, om URL-strängen inte är kodad bör det inte finnas en "%" i URL-strängen, annars är URL:en inte en giltig URL. Om kunden behöver skapa en blob med "%" i dess blobnamn använder du "%25" insead av "%". Precis som ovan 3:e exemplet. Och följande URL-strängar är ogiltiga:

  • "http://account.blob.core.windows.net/con/b%"Och jag har inte hört talas
  • "http://account.blob.core.windows.net/con/b%2"Och jag har inte hört talas
  • "http://account.blob.core.windows.net/con/b%G"Och jag har inte hört talas

Ett annat specialtecken är "?", använd "%2F" för att representera ett blobnamn med "?" i en URL-sträng.

Strategi för containerName, blobName eller andra specifika XXXName-parametrar i metoder som BlobURL.fromContainerURL(containerURL, blobName)

Vi tillämpar strategi ett och anropar encodeURIComponent för dessa parametrar som blobName. För det som kunder skickar in är ett vanligt namn i stället för en URL.
getURLParameter(string, string)

Hämta URL-parameter efter namn.
getURLPath(string)

Hämta URL-sökvägen från en URL-sträng.
getURLQueries(string)

Hämta url-frågenyckelpar från en URL-sträng.
padStart(string, number, undefined | string)

String.prototype.padStart()
setURLHost(string, string)

Ange URL-värd.
setURLParameter(string, string, undefined | string)

Ange URL-parameternamn och -värde. Om namnet finns i URL-parametrar ersätts det gamla värdet med namnnyckeln. Om du inte anger något värde tas parametern bort.
truncatedISO8061Date(Date, undefined | false | true)

Avrundar ett datum till sekunder.
streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)

Läser en läsbar ström till buffert. Fyll bufferten från förskjutning till slutpunkt.

Funktionsinformation

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Genererar ett <xref:SASQueryParameters> objekt som innehåller alla SAS-frågeparametrar som behövs för att göra en faktisk REST-begäran.

function generateAccountSASQueryParameters(accountSASSignatureValues: IAccountSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Parametrar

accountSASSignatureValues
IAccountSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Returer

SASQueryParameters

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Skapar en instans av SASQueryParameters.

Accepterar endast nödvändiga inställningar som krävs för att skapa en SAS. För valfria inställningar anger du motsvarande egenskaper direkt, till exempel behörigheter, startTime och identifierare.

VARNING! När identifieraren inte har angetts krävs behörigheter och expiryTime. Du MÅSTE tilldela värdet till identifieraren eller expiryTime & behörigheter manuellt om du börjar med den här konstruktorn.

function generateFileSASQueryParameters(fileSASSignatureValues: IFileSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Parametrar

fileSASSignatureValues
IFileSASSignatureValues
sharedKeyCredential
SharedKeyCredential

Returer

SASQueryParameters

ipRangeToString(IIPRange)

Generera IPRange-formatsträng. Exempel: "8.8.8.8.8" eller "1.1.1.1-255.255.255.255"

function ipRangeToString(ipRange: IIPRange)

Parametrar

ipRange
IIPRange

Returer

string

rangeToString(IRange)

Generera en intervallsträng. Till exempel: "bytes=255-" eller "bytes=0-511"

function rangeToString(iRange: IRange)

Parametrar

iRange
IRange

Returer

string

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

ENDAST TILLGÄNGLIGT I WEBBLÄSARE. Laddar upp ett blob-/fil-/matrisbuffer-/ArrayBufferView-objekt i webbläsaren till en Azure-fil.

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

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

browserData

Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer eller ArrayBufferView

fileURL
FileURL
options
IUploadToAzureFileOptions

Returer

Promise<void>

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

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure-fil parallellt med en buffert. Förskjutning och antal är valfria, skicka 0 för att båda ska kunna ladda ned hela filen.

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

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

buffer

Buffer

Buffert som ska fyllas, måste ha en längd som är större än antalet

fileURL
FileURL

Ett FileURL-objekt

offset

number

Från vilken position Azure-filen ska laddas ned

count

undefined | number

options
IDownloadFromAzureFileOptions

Returer

Promise<void>

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar upp en lokal fil till en Azure-fil.

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

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

filePath

string

Fullständig sökväg för lokal fil

fileURL
FileURL

FileURL

options
IUploadToAzureFileOptions

Returer

Promise<void>

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

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar upp en Node.js läsbar dataström till en Azure-fil. Den här metoden försöker skapa en Azure och börjar sedan ladda upp segment för segment. Storleken på segment definieras av bufferSize parameter. Kontrollera att den potentiella storleken på dataströmmen inte överskrider filstorleken.

TIPS FÖR PRESTANDAFÖRBÄTTRING:

  • HighWaterMark för indataström är bättre att ange samma värde med bufferSize-parametern, vilket undviker buffer.concat()-åtgärder.
function uploadStreamToAzureFile(aborter: Aborter, stream: Readable, size: number, fileURL: FileURL, bufferSize: number, maxBuffers: number, options?: IUploadStreamToAzureFileOptions)

Parametrar

aborter
Aborter

Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran

stream

Readable

Node.js läsbar ström. Måste vara mindre eller lika med filstorleken.

size

number

Storleken på filen som ska skapas. Maxiumstorleken som tillåts är 1 TB. Om det här värdet är större än strömstorleken kommer det att finnas tomma byte i filsvansen.

fileURL
FileURL

En FileURL-instans

bufferSize

number

Storleken på varje buffert som allokeras i byte, även storleken på segment/intervall under den uppladdade filen. Storleken måste vara > 0 och <= 4 * 1024 * 1024 (4 MB)

maxBuffers

number

Maximalt antal buffertar allokeras under uppladdningen, positiv korrelation med maximal samtidighet vid uppladdning

options
IUploadStreamToAzureFileOptions

Returer

Promise<void>

fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType) 

function fileAttributesToString(fileAttributes: FileSystemAttributes | FileAttributesPreserveType)

Parametrar

fileAttributes

FileSystemAttributes | FileAttributesPreserveType

Returer

string

fileCreationTimeToString(Date | TimeNowType | TimePreserveType) 

function fileCreationTimeToString(time: Date | TimeNowType | TimePreserveType)

Parametrar

time

Date | TimeNowType | TimePreserveType

Returer

string

fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType) 

function fileLastWriteTimeToString(time: Date | TimeNowType | TimePreserveType)

Parametrar

time

Date | TimeNowType | TimePreserveType

Returer

string

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions) 

function validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(options: IFileAndDirectoryCreateCommonOptions)

Parametrar

options
IFileAndDirectoryCreateCommonOptions

Returer

IFileAndDirectoryCreateCommonOptions

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions) 

function validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(options: IFileAndDirectorySetPropertiesCommonOptions)

Parametrar

options
IFileAndDirectorySetPropertiesCommonOptions

Returer

IFileAndDirectorySetPropertiesCommonOptions

validateFilePermissionOptions(undefined | string, undefined | string) 

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

Parametrar

filePermission

undefined | string

filePermissionKey

undefined | string

NewRetryPolicyFactory(IRetryOptions)

En fabriksmetod som används för att generera en RetryPolicy-fabrik.

function NewRetryPolicyFactory(retryOptions?: IRetryOptions)

Parametrar

retryOptions
IRetryOptions

Returer

RequestPolicyFactory

blobToArrayBuffer(Blob)

Konvertera ett webbläsarblobobjekt till ArrayBuffer.

function blobToArrayBuffer(blob: Blob)

Parametrar

blob

Blob

Returer

Promise<ArrayBuffer>

appendToURLPath(string, string)

Lägg till en sträng i URL-sökvägen. Tar bort duplicerade "/" framför strängen när URL-sökvägen slutar med "/".

function appendToURLPath(url: string, name: string)

Parametrar

url

string

Käll-URL-sträng

name

string

Sträng som ska läggas till i URL

Returer

string

En uppdaterad URL-sträng

base64decode(string)

Base64-avkodning.

function base64decode(encodedString: string)

Parametrar

encodedString

string

Returer

string

base64encode(string)

Base64-kodning.

function base64encode(content: string)

Parametrar

content

string

Returer

string

delay(number, AbortSignalLike, Error)

Fördröj angivet tidsintervall.

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

Parametrar

timeInMs

number

aborter

AbortSignalLike

abortError

Error

Returer

Promise<unknown>

escapeURLPath(string)

Reserverade URL-tecken måste vara korrekt undantagna för lagringstjänster som Blob eller File.

URL-kodning och escape-strategi för JSv10 SDK:er

När kunder skickar en URL-sträng till konstruktorn XXXURL-klasser kan URL-strängen redan vara URL-kodad eller inte. Men innan du skickar till Azure Storage-servern måste URL:en kodas. Det är dock svårt för en SDK att gissa om URL-strängen har kodats eller inte. Vi har två potentiella strategier och valde strategi två för XXXURL-konstruktorerna.

Strategi ett: Anta att kundens URL-sträng inte är kodad och alltid kodar URL-strängen i SDK.

Det här är vad äldre V2 SDK gör, enkelt och fungerar för de flesta av fallen.

  • När kundens URL-sträng är "http://account.blob.core.windows.net/con/b:", kodar SDK den till "http://account.blob.core.windows.net/con/b%3A" och skicka till servern. En blob med namnet "b:" skapas.
  • När kundens URL-sträng är "http://account.blob.core.windows.net/con/b%3A", kodar SDK den till "http://account.blob.core.windows.net/con/b%253A" och skicka till servern. En blob med namnet "b%3A" skapas.

Men den här strategin gör det inte möjligt att skapa en blob med "?" i dess namn. För när kundens URL-sträng är "http://account.blob.core.windows.net/con/blob?name", behandlas "?name" som URL-paramter i stället för blobnamn. Om kundens URL-sträng ärhttp://account.blob.core.windows.net/con/blob%3Fname"skapas en blob med namnet "blob%3Fname". V2 SDK har inte det här problemet eftersom det inte tillåter att kunden skickar en fullständig URL. Det accepterar ett separat blobnamn och encodeURIComponent för det. Vi kan inte acceptera att ett SDK inte kan skapa ett blobnamn med "?". Så vi implementerar strategi två:

Strategi två: SDK förutsätter inte att URL:en har kodats eller inte. Det kommer bara att undkomma specialtecken.

Detta är vad V10 Blob Go SDK gör. Den accepterar en URL-typ i Go och anropar URL. EscapePath() för att undkomma de speciella tecken som inte är kapslade.

  • När kundens URL-sträng är "http://account.blob.core.windows.net/con/b:", kommer SDK att fly ":" som "http://account.blob.core.windows.net/con/b%3A" och skicka till servern. En blob med namnet "b:" skapas.
  • När kundens URL-sträng är "http://account.blob.core.windows.net/con/b%3A", finns det inga specialtecken, så skicka "http://account.blob.core.windows.net/con/b%3A" till servern. En blob med namnet "b:" skapas.
  • När kundens URL-sträng är "http://account.blob.core.windows.net/con/b%253A", finns det inga specialtecken, så skicka "http://account.blob.core.windows.net/con/b%253A" till servern. En blob med namnet "b%3A" skapas.

Den här strategin ger oss flexibilitet att skapa med specialtecken. Men "%" behandlas som specialtecken, om URL-strängen inte är kodad bör det inte finnas en "%" i URL-strängen, annars är URL:en inte en giltig URL. Om kunden behöver skapa en blob med "%" i dess blobnamn använder du "%25" insead av "%". Precis som ovan 3:e exemplet. Och följande URL-strängar är ogiltiga:

  • "http://account.blob.core.windows.net/con/b%"Och jag har inte hört talas
  • "http://account.blob.core.windows.net/con/b%2"Och jag har inte hört talas
  • "http://account.blob.core.windows.net/con/b%G"Och jag har inte hört talas

Ett annat specialtecken är "?", använd "%2F" för att representera ett blobnamn med "?" i en URL-sträng.

Strategi för containerName, blobName eller andra specifika XXXName-parametrar i metoder som BlobURL.fromContainerURL(containerURL, blobName)

Vi tillämpar strategi ett och anropar encodeURIComponent för dessa parametrar som blobName. För det som kunder skickar in är ett vanligt namn i stället för en URL.

function escapeURLPath(url: string)

Parametrar

url

string

Returer

string

getURLParameter(string, string)

Hämta URL-parameter efter namn.

function getURLParameter(url: string, name: string)

Parametrar

url

string

name

string

Returer

string | string[] | undefined

getURLPath(string)

Hämta URL-sökvägen från en URL-sträng.

function getURLPath(url: string)

Parametrar

url

string

Käll-URL-sträng

Returer

string | undefined

getURLQueries(string)

Hämta url-frågenyckelpar från en URL-sträng.

function getURLQueries(url: string)

Parametrar

url

string

Returer

[key: string]: string

padStart(string, number, undefined | string)

String.prototype.padStart()

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

Parametrar

currentString

string

targetLength

number

padString

undefined | string

Returer

string

setURLHost(string, string)

Ange URL-värd.

function setURLHost(url: string, host: string)

Parametrar

url

string

Käll-URL-sträng

host

string

Ny värdsträng

Returer

string

En uppdaterad URL-sträng

setURLParameter(string, string, undefined | string)

Ange URL-parameternamn och -värde. Om namnet finns i URL-parametrar ersätts det gamla värdet med namnnyckeln. Om du inte anger något värde tas parametern bort.

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

Parametrar

url

string

Käll-URL-sträng

name

string

Parameternamn

value

undefined | string

Returer

string

En uppdaterad URL-sträng

truncatedISO8061Date(Date, undefined | false | true)

Avrundar ett datum till sekunder.

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

Parametrar

date

Date

withMilliseconds

undefined | false | true

Returer

string

Datumsträng i ISO8061 format, med eller utan komponenten 7 millisekunder

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

Läser en läsbar ström till buffert. Fyll bufferten från förskjutning till slutpunkt.

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

Parametrar

stream

ReadableStream

En Node.js läsbar ström

buffer

Buffer

Buffert som ska fyllas i, längden måste >= offset

offset

number

Från vilken position i bufferten som ska fyllas, inklusive

end

number

Till vilken position i bufferten som ska fyllas, exklusivt

encoding

undefined | string

Returer

Promise<void>