@azure/storage-file package
Klassen
| Aborter |
Een aborter-instantie implementeert AbortSignal-interface, kan HTTP-aanvragen afbreken.
Voor een bestaand exemplaar afgebroken:
|
| AccountSASPermissions |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Dit is een helperklasse voor het samenstellen van een tekenreeks die de machtigingen vertegenwoordigt die zijn verleend door een AccountSAS. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en ingesteld als het machtigingsveld voor een <xref:IAccountSASSignatureValues>-object. Het is mogelijk om de machtigingstekenreeks zonder deze klasse samen te stellen, maar de volgorde van de machtigingen is bijzonder en deze klasse garandeert juistheid. |
| AccountSASResourceTypes |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Dit is een helperklasse voor het samenstellen van een tekenreeks die de resources vertegenwoordigt die toegankelijk zijn voor een AccountSAS. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, toegang verleent tot dat resourcetype. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en ingesteld als het resourceveld op een <xref:IAccountSASSignatureValues>-object. Het is mogelijk om de tekenreeks voor resources zonder deze klasse samen te stellen, maar de volgorde van de resources is bijzonder en deze klasse garandeert juistheid. |
| AccountSASServices |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Dit is een helperklasse voor het samenstellen van een tekenreeks die de services vertegenwoordigt die toegankelijk zijn voor een AccountSAS. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, toegang verleent tot die service. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en ingesteld als het servicesveld op een <xref:IAccountSASSignatureValues>-object. Het is mogelijk om de servicesreeks zonder deze klasse samen te stellen, maar de volgorde van de services is bijzonder en deze klasse garandeert juistheid. |
| BrowserPolicyFactory |
BrowserPolicyFactory is een fabrieksklasse die helpt bij het genereren van BrowserPolicy-objecten. |
| DirectoryURL |
Een DirectoryURL vertegenwoordigt een URL naar de Azure Storage-map, zodat u de bestanden en mappen kunt bewerken. |
| FileSASPermissions |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Dit is een helperklasse voor het samenstellen van een tekenreeks die de machtigingen vertegenwoordigt die door een ServiceSAS aan een bestand worden verleend. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en ingesteld als het machtigingsveld voor een <xref:IFileSASSignatureValues> object. Het is mogelijk om de machtigingstekenreeks zonder deze klasse samen te stellen, maar de volgorde van de machtigingen is bijzonder en deze klasse garandeert juistheid. |
| FileSystemAttributes |
Dit is een helperklasse voor het maken van een tekenreeks die de NTFS-kenmerken aan een bestand of map vertegenwoordigt. |
| FileURL |
Een FileURL vertegenwoordigt een URL naar een Azure Storage-bestand. |
| KeepAlivePolicyFactory |
KeepAlivePolicyFactory is een fabrieksklasse die helpt bij het genereren van KeepAlivePolicy-objecten. |
| LoggingPolicyFactory |
LoggingPolicyFactory is een fabrieksklasse die helpt bij het genereren van LoggingPolicy-objecten. |
| Pipeline |
Een pijplijnklasse met HTTP-aanvraagbeleid. U kunt een standaardpijplijn maken door StorageURL.newPipeline() aan te roepen. U kunt ook een pijplijn maken met uw eigen beleid door de constructor van Pipeline. Raadpleeg StorageURL.newPipeline() en opgegeven beleidsregels als referentie voordat u uw aangepaste pijplijn implementeert. |
| RetryPolicyFactory |
RetryPolicyFactory is een fabrieksklasse die helpt bij het genereren van RetryPolicy-objecten. |
| SASQueryParameters |
Vertegenwoordigt de onderdelen waaruit de queryparameters van Azure Storage SAS bestaan. Dit type wordt niet rechtstreeks samengesteld door de gebruiker; deze wordt alleen gegenereerd door de typen <xref:IAccountSASSignatureValues> en <xref:IFileSASSignatureValues>. Zodra deze is gegenereerd, kan deze worden gecodeerd in een {@code String} en rechtstreeks aan een URL worden toegevoegd (hoewel u hier voorzichtig moet zijn als er bestaande queryparameters zijn, wat van invloed kan zijn op de juiste manier om deze queryparameters toe te voegen). OPMERKING: Exemplaren van deze klasse zijn onveranderbaar. |
| ServiceURL |
Een ServiceURL vertegenwoordigt een URL naar de Azure Storage File-service waarmee u bestandsshares kunt bewerken. |
| ShareSASPermissions |
Dit is een helperklasse voor het samenstellen van een tekenreeks die de machtigingen vertegenwoordigt die door een ServiceSAS aan een share worden verleend. Als u een waarde instelt op true, betekent dit dat elke SAS die deze machtigingen gebruikt, machtigingen verleent voor die bewerking. Zodra alle waarden zijn ingesteld, moet dit worden geserialiseerd met toString en ingesteld als het machtigingsveld voor een <xref:IFileSASSignatureValues> object. Het is mogelijk om de machtigingstekenreeks zonder deze klasse samen te stellen, maar de volgorde van de machtigingen is bijzonder en deze klasse garandeert juistheid. |
| ShareURL |
Een ShareURL vertegenwoordigt een URL naar de Azure Storage-share, zodat u de mappen en bestanden ervan kunt bewerken. |
| StorageURL |
Een ServiceURL vertegenwoordigt een gebaseerde URL-klasse voor ServiceURL, ContainerURL en enzovoort. |
| TelemetryPolicyFactory |
TelemetryPolicyFactory is een fabrieksklasse die helpt bij het genereren van TelemetryPolicy-objecten. |
| UniqueRequestIDPolicyFactory |
UniqueRequestIDPolicyFactory is een fabrieksklasse die helpt bij het genereren van UniqueRequestIDPolicy-objecten. |
| AnonymousCredential |
AnonymousCredential biedt een credentialPolicyCreator-lid dat wordt gebruikt om AnonymousCredentialPolicy-objecten te maken. AnonymousCredentialPolicy wordt gebruikt met HTTP(S)-aanvragen die openbare resources lezen of voor gebruik met Shared Access Signatures (SAS). |
| Credential |
Referentie is een abstracte klasse voor ondertekening van HTTP-aanvragen voor Azure Storage. Deze klasse host een credentialPolicyCreator-factory die CredentialPolicy genereert. |
| SharedKeyCredential |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. SharedKeyCredential voor accountsleutelautorisatie van de Azure Storage-service. |
| Directory |
Klasse die een map vertegenwoordigt. |
| File |
Klasse die een bestand vertegenwoordigt. |
| Service |
Klasse die een service vertegenwoordigt. |
| Share |
Klasse die een Share vertegenwoordigt. |
| StorageClient | |
| StorageClientContext | |
| AnonymousCredentialPolicy |
AnonymousCredentialPolicy wordt gebruikt met HTTP(S)-aanvragen die openbare resources lezen of voor gebruik met Shared Access Signatures (SAS). |
| BrowserPolicy |
BrowserPolicy verwerkt verschillen tussen Node.js en browserruntime, waaronder:
|
| CredentialPolicy |
Referentiebeleid dat wordt gebruikt om HTTP(S)-aanvragen te ondertekenen voordat deze worden verzonden. Dit is een abstracte klasse. |
| KeepAlivePolicy |
KeepAlivePolicy is een beleid dat wordt gebruikt om de instellingen voor keep alive voor elke aanvraag te beheren. |
| LoggingPolicy |
LoggingPolicy is een beleid dat wordt gebruikt om aanvragen te registreren. |
| RetryPolicy |
Beleid voor opnieuw proberen met exponentieel opnieuw proberen en lineaire nieuwe poging geïmplementeerd. |
| SharedKeyCredentialPolicy |
SharedKeyCredentialPolicy is een beleid dat wordt gebruikt om een HTTP-aanvraag te ondertekenen met een gedeelde sleutel. |
| TelemetryPolicy |
TelemetryPolicy is een beleid dat wordt gebruikt voor het taggen van headers van gebruikersagents voor elke aanvraag. |
| UniqueRequestIDPolicy |
UniqueRequestIDPolicy genereert een UUID als headerwaarde x-ms-ms-request-id. |
| Batch |
Batch biedt eenvoudige parallelle uitvoering met gelijktijdigheidslimieten. Stopt met het uitvoeren van linkerbewerkingen wanneer een van de uitgevoerde bewerkingen een fout genereert. Maar Batch kan lopende bewerkingen niet annuleren, u moet ze zelf annuleren. |
| BufferScheduler |
Deze klasse accepteert een Node.js leesbare stroom als invoer en blijft gegevens van de stroom lezen in de interne bufferstructuur totdat het maxBuffers bereikt. Elke beschikbare buffer probeert uitgaandeHandler te activeren. De interne bufferstructuur bevat een binnenkomende buffermatrix en een uitgaande buffermatrix. De binnenkomende buffermatrix bevat de 'lege' buffers die kunnen worden gevuld met nieuwe binnenkomende gegevens. De uitgaande matrix bevat de gevulde buffers die moeten worden verwerkt door outgoingHandler. Elke bovenbuffergrootte wordt gedefinieerd door parameterbufferSize. NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING <NUM_OF_ALL_BUFFERS = maxBuffers TIPS VOOR PRESTATIEVERBETERING:
|
| RetriableReadableStream |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Een Node.js ReadableStream wordt intern opnieuw geprobeerd wanneer interne ReadableStream onverwacht eindigt. |
Interfaces
| IDirectoryCreateOptions | |
| IDirectoryForceCloseHandlesSegmentOptions | |
| IDirectoryListFilesAndDirectoriesSegmentOptions | |
| IDirectoryListHandlesSegmentOptions | |
| IDirectoryProperties | |
| IFileCreateOptions | |
| IFileDownloadOptions | |
| IFileGetRangeListOptions |
De optie wordt gedefinieerd als pariteit voor REST-definitie. Hoewel het nu niet gereed is om te worden gebruikt, is Crc64 van broninhoud niet toegankelijk. |
| IFileListHandlesSegmentOptions | |
| IFileProperties | |
| IFileStartCopyOptions | |
| IFileUploadRangeOptions | |
| ISetPropertiesResponse | |
| IAccountSASSignatureValues |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. IAccountSASSignatureValues wordt gebruikt voor het genereren van een Shared Access Signature (SAS) voor een Azure Storage-account. Zodra alle waarden hier correct zijn ingesteld, roept u generateSASQueryParameters() aan om een weergave van de SAS te verkrijgen die daadwerkelijk kan worden toegepast op bestands-URL's. Opmerking: zowel deze klasse als <xref:SASQueryParameters> bestaan omdat de vorige veranderlijk is en een logische representatie terwijl de laatste onveranderbaar is en wordt gebruikt om werkelijke REST-aanvragen te genereren. |
| IFileSASSignatureValues |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. IFileSASSignatureValues wordt gebruikt om SAS-tokens voor bestandsservices te genereren voor shares of bestanden. |
| IIPRange |
Toegestaan IP-bereik voor een SAS. |
| IRange |
Bereik voor servicebewerkingen. |
| IKeepAliveOptions |
Interface van KeepAlivePolicy-opties. |
| IRequestLogOptions |
RequestLogOptions configureert het gedrag van het beleid voor opnieuw proberen. |
| IPipelineOptions |
Optie-interface voor pijplijnconstructor. |
| IRetryOptions |
Interface voor opties voor opnieuw proberen. |
| IServiceListSharesSegmentOptions | |
| IShareCreateOptions | |
| IShareCreateSnapshotOptions | |
| IShareDeleteMethodOptions | |
| ISignedIdentifier | |
| INewPipelineOptions |
Optie-interface voor de methode Pipeline.newPipeline. |
| ITelemetryOptions |
Interface van TelemetryPolicy-opties. |
| AccessPolicy |
Een toegangsbeleid. |
| CorsRule |
CORS is een HTTP-functie waarmee een webtoepassing die onder het ene domein wordt uitgevoerd, toegang heeft tot resources in een ander domein. Webbrowsers implementeren een beveiligingsbeperking die bekend staat als beleid voor dezelfde oorsprong waarmee wordt voorkomen dat een webpagina API's in een ander domein aanroept; CORS biedt een veilige manier om toe te staan dat één domein (het oorspronkelijke domein) API's in een ander domein aanroept. |
| DirectoryCreateHeaders |
Hiermee definieert u headers voor de bewerking Maken. |
| DirectoryCreateOptionalParams |
Optionele parameters. |
| DirectoryDeleteHeaders |
Hiermee definieert u headers voor de bewerking Verwijderen. |
| DirectoryDeleteMethodOptionalParams |
Optionele parameters. |
| DirectoryForceCloseHandlesHeaders |
Definieert headers voor forceCloseHandles-bewerking. |
| DirectoryForceCloseHandlesOptionalParams |
Optionele parameters. |
| DirectoryGetPropertiesHeaders |
Definieert headers voor getProperties-bewerking. |
| DirectoryGetPropertiesOptionalParams |
Optionele parameters. |
| DirectoryItem |
Een vermeld mapitem. |
| DirectoryListFilesAndDirectoriesSegmentHeaders |
Hiermee definieert u headers voor de bewerking ListFilesAndDirectoriesSegment. |
| DirectoryListFilesAndDirectoriesSegmentOptionalParams |
Optionele parameters. |
| DirectoryListHandlesHeaders |
Hiermee definieert u headers voor de bewerking ListHandles. |
| DirectoryListHandlesOptionalParams |
Optionele parameters. |
| DirectorySetMetadataHeaders |
Definieert headers voor setmetadata-bewerking. |
| DirectorySetMetadataOptionalParams |
Optionele parameters. |
| DirectorySetPropertiesHeaders |
Hiermee definieert u headers voor de bewerking SetProperties. |
| DirectorySetPropertiesOptionalParams |
Optionele parameters. |
| FileAbortCopyHeaders |
Hiermee definieert u headers voor de bewerking AbortCopy. |
| FileAbortCopyOptionalParams |
Optionele parameters. |
| FileCreateHeaders |
Hiermee definieert u headers voor de bewerking Maken. |
| FileCreateOptionalParams |
Optionele parameters. |
| FileDeleteHeaders |
Hiermee definieert u headers voor de bewerking Verwijderen. |
| FileDeleteMethodOptionalParams |
Optionele parameters. |
| FileDownloadHeaders |
Definieert headers voor downloadbewerking. |
| FileDownloadOptionalParams |
Optionele parameters. |
| FileForceCloseHandlesHeaders |
Definieert headers voor forceCloseHandles-bewerking. |
| FileForceCloseHandlesOptionalParams |
Optionele parameters. |
| FileGetPropertiesHeaders |
Definieert headers voor getProperties-bewerking. |
| FileGetPropertiesOptionalParams |
Optionele parameters. |
| FileGetRangeListHeaders |
Definieert headers voor getRangeList-bewerking. |
| FileGetRangeListOptionalParams |
Optionele parameters. |
| FileHTTPHeaders |
Aanvullende parameters voor een set bewerkingen, zoals: File_create, File_setHTTPHeaders. |
| FileItem |
Een vermeld bestandsitem. |
| FileListHandlesHeaders |
Hiermee definieert u headers voor de bewerking ListHandles. |
| FileListHandlesOptionalParams |
Optionele parameters. |
| FileProperty |
Bestandseigenschappen. |
| FileSetHTTPHeadersHeaders |
Hiermee definieert u headers voor de bewerking SetHTTPHeaders. |
| FileSetHTTPHeadersOptionalParams |
Optionele parameters. |
| FileSetMetadataHeaders |
Definieert headers voor setmetadata-bewerking. |
| FileSetMetadataOptionalParams |
Optionele parameters. |
| FileStartCopyHeaders |
Hiermee definieert u headers voor de StartCopy-bewerking. |
| FileStartCopyOptionalParams |
Optionele parameters. |
| FileUploadRangeFromURLHeaders |
Hiermee definieert u headers voor de bewerking UploadRangeFromURL. |
| FileUploadRangeFromURLOptionalParams |
Optionele parameters. |
| FileUploadRangeHeaders |
Hiermee definieert u headers voor de UploadRange-bewerking. |
| FileUploadRangeOptionalParams |
Optionele parameters. |
| FilesAndDirectoriesListSegment |
Abstract voor vermeldingen die kunnen worden vermeld in Directory. |
| HandleItem |
Een vermelde Azure Storage-handle-item. |
| ListFilesAndDirectoriesSegmentResponse |
Een opsomming van mappen en bestanden. |
| ListHandlesResponse |
Een opsomming van ingangen. |
| ListSharesResponse |
Een opsomming van shares. |
| Metrics |
Metrische gegevens van Storage Analytics voor bestandsservice. |
| Permission |
Machtiging (een beveiligingsdescriptor) die wordt beschreven in de Security Descriptor Definition Language (SDDL). |
| Range |
Een Azure Storage-bestandsbereik. |
| RetentionPolicy |
Het bewaarbeleid. |
| ServiceGetPropertiesHeaders |
Definieert headers voor getProperties-bewerking. |
| ServiceGetPropertiesOptionalParams |
Optionele parameters. |
| ServiceListSharesSegmentHeaders |
Hiermee definieert u headers voor de bewerking ListSharesSegment. |
| ServiceListSharesSegmentOptionalParams |
Optionele parameters. |
| ServiceSetPropertiesHeaders |
Hiermee definieert u headers voor de bewerking SetProperties. |
| ServiceSetPropertiesOptionalParams |
Optionele parameters. |
| ShareCreateHeaders |
Hiermee definieert u headers voor de bewerking Maken. |
| ShareCreateOptionalParams |
Optionele parameters. |
| ShareCreatePermissionHeaders |
Definieert headers voor createPermission-bewerking. |
| ShareCreatePermissionOptionalParams |
Optionele parameters. |
| ShareCreateSnapshotHeaders |
Definieert headers voor createSnapshot-bewerking. |
| ShareCreateSnapshotOptionalParams |
Optionele parameters. |
| ShareDeleteHeaders |
Hiermee definieert u headers voor de bewerking Verwijderen. |
| ShareDeleteMethodOptionalParams |
Optionele parameters. |
| ShareGetAccessPolicyHeaders |
Definieert headers voor getAccessPolicy-bewerking. |
| ShareGetAccessPolicyOptionalParams |
Optionele parameters. |
| ShareGetPermissionHeaders |
Hiermee definieert u headers voor getPermission-bewerking. |
| ShareGetPermissionOptionalParams |
Optionele parameters. |
| ShareGetPropertiesHeaders |
Definieert headers voor getProperties-bewerking. |
| ShareGetPropertiesOptionalParams |
Optionele parameters. |
| ShareGetStatisticsHeaders |
Hiermee definieert u headers voor de bewerking GetStatistics. |
| ShareGetStatisticsOptionalParams |
Optionele parameters. |
| ShareItem |
Een vermelde Azure Storage-shareitem. |
| ShareProperties |
Eigenschappen van een share. |
| ShareSetAccessPolicyHeaders |
Definieert headers voor de bewerking SetAccessPolicy. |
| ShareSetAccessPolicyOptionalParams |
Optionele parameters. |
| ShareSetMetadataHeaders |
Definieert headers voor setmetadata-bewerking. |
| ShareSetMetadataOptionalParams |
Optionele parameters. |
| ShareSetQuotaHeaders |
Definieert headers voor setquota-bewerking. |
| ShareSetQuotaOptionalParams |
Optionele parameters. |
| ShareStats |
Statistieken voor de share. |
| SignedIdentifier |
Ondertekende id. |
| SourceModifiedAccessConditions |
Aanvullende parameters voor de uploadRangeFromURL-bewerking. |
| StorageError |
Een interface die StorageError vertegenwoordigt. |
| StorageServiceProperties |
Eigenschappen van opslagservice. |
| IDownloadFromAzureFileOptions |
Optie-interface voor DownloadAzurefileToBuffer. |
| IUploadToAzureFileOptions |
Optie-interface voor uploadFileToAzureFile en uploadSeekableStreamToAzureFile. |
| IUploadStreamToAzureFileOptions |
Optie-interface voor uploadStreamToAzureFile. |
| IFileAndDirectoryCreateCommonOptions | |
| IFileAndDirectorySetPropertiesCommonOptions | |
| IFileHTTPHeaders | |
| IMetadata | |
| IRetriableReadableStreamOptions | |
Type-aliassen
| FileDownloadResponse |
Bevat antwoordgegevens voor de downloadbewerking. |
| FileGetRangeListResponse |
Bevat antwoordgegevens voor de getRangeList-bewerking. |
| ShareGetAccessPolicyResponse |
Bevat antwoordgegevens voor de getAccessPolicy-bewerking. |
| ShareGetStatisticsResponse |
Bevat antwoordgegevens voor de bewerking getStatistics. |
| CredentialPolicyCreator |
Een factory-functie die een nieuwe CredentialPolicy maakt die gebruikmaakt van de opgegeven nextPolicy. |
| CopyStatusType |
Definieert waarden voor CopyStatusType. Mogelijke waarden zijn: 'in behandeling', 'geslaagd', 'afgebroken', 'mislukt' |
| DeleteSnapshotsOptionType |
Definieert waarden voor DeleteSnapshotsOptionType. Mogelijke waarden zijn: 'include' |
| DirectoryCreateResponse |
Bevat antwoordgegevens voor de bewerking maken. |
| DirectoryDeleteResponse |
Bevat antwoordgegevens voor de deleteMethod-bewerking. |
| DirectoryForceCloseHandlesResponse |
Bevat antwoordgegevens voor de forceCloseHandles-bewerking. |
| DirectoryGetPropertiesResponse |
Bevat antwoordgegevens voor de getProperties-bewerking. |
| DirectoryListFilesAndDirectoriesSegmentResponse |
Bevat antwoordgegevens voor de bewerking listFilesAndDirectoriesSegment. |
| DirectoryListHandlesResponse |
Bevat antwoordgegevens voor de bewerking listHandles. |
| DirectorySetMetadataResponse |
Bevat antwoordgegevens voor de setMetadata-bewerking. |
| DirectorySetPropertiesResponse |
Bevat antwoordgegevens voor de bewerking setProperties. |
| FileAbortCopyResponse |
Bevat antwoordgegevens voor de abortCopy-bewerking. |
| FileCreateResponse |
Bevat antwoordgegevens voor de bewerking maken. |
| FileDeleteResponse |
Bevat antwoordgegevens voor de deleteMethod-bewerking. |
| FileForceCloseHandlesResponse |
Bevat antwoordgegevens voor de forceCloseHandles-bewerking. |
| FileGetPropertiesResponse |
Bevat antwoordgegevens voor de getProperties-bewerking. |
| FileListHandlesResponse |
Bevat antwoordgegevens voor de bewerking listHandles. |
| FileRangeWriteType |
Definieert waarden voor FileRangeWriteType. Mogelijke waarden zijn: 'update', 'clear' |
| FileSetHTTPHeadersResponse |
Bevat antwoordgegevens voor de bewerking setHTTPHeaders. |
| FileSetMetadataResponse |
Bevat antwoordgegevens voor de setMetadata-bewerking. |
| FileStartCopyResponse |
Bevat antwoordgegevens voor de startCopy-bewerking. |
| FileType |
Definieert waarden voor FileType. Mogelijke waarden zijn: 'Bestand' |
| FileUploadRangeFromURLResponse |
Bevat antwoordgegevens voor de uploadRangeFromURL-bewerking. |
| FileUploadRangeResponse |
Bevat antwoordgegevens voor de uploadRange-bewerking. |
| ListSharesIncludeType |
Definieert waarden voor ListSharesIncludeType. Mogelijke waarden zijn: 'momentopnamen', 'metagegevens' |
| ServiceGetPropertiesResponse |
Bevat antwoordgegevens voor de getProperties-bewerking. |
| ServiceListSharesSegmentResponse |
Bevat antwoordgegevens voor de bewerking listSharesSegment. |
| ServiceSetPropertiesResponse |
Bevat antwoordgegevens voor de bewerking setProperties. |
| ShareCreatePermissionResponse |
Bevat antwoordgegevens voor de createPermission-bewerking. |
| ShareCreateResponse |
Bevat antwoordgegevens voor de bewerking maken. |
| ShareCreateSnapshotResponse |
Bevat antwoordgegevens voor de createSnapshot-bewerking. |
| ShareDeleteResponse |
Bevat antwoordgegevens voor de deleteMethod-bewerking. |
| ShareGetPermissionResponse |
Bevat antwoordgegevens voor de getPermission-bewerking. |
| ShareGetPropertiesResponse |
Bevat antwoordgegevens voor de getProperties-bewerking. |
| ShareSetAccessPolicyResponse |
Bevat antwoordgegevens voor de setAccessPolicy-bewerking. |
| ShareSetMetadataResponse |
Bevat antwoordgegevens voor de setMetadata-bewerking. |
| ShareSetQuotaResponse |
Bevat antwoordgegevens voor de setQuota-bewerking. |
| StorageErrorCode |
Definieert waarden voor StorageErrorCode. Mogelijke waarden zijn: 'AccountAlreadyExists', 'AccountBeingCreated', 'AccountIsDisabled', 'AuthenticationFailed', 'AuthorizationFailure', 'ConditionHeadersNotSupported', 'ConditionNotMet', 'EmptyMetadataKey', 'InsufficientAccountPermissions', 'InternalError', 'InvalidAuthenticationInfo', 'InvalidHeaderValue', 'InvalidHttpVerb', 'InvalidInput', 'InvalidMd5', 'InvalidMetadata', 'InvalidQueryParameterValue', 'InvalidRange', 'InvalidResourceName', 'InvalidUri', ' 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 |
Geeft aan dat bestaande bestandskenmerken ongewijzigd blijven. |
| FilePermissionInheritType |
Geeft aan dat de bestandsmachtiging wordt overgenomen van de bovenliggende map. |
| FilePermissionPreserveType |
Geeft aan dat de waarde van de bestaande bestandsmachtiging ongewijzigd blijft. |
| TimeNowType |
Hiermee wordt de instelling aangegeven als de tijd van de aanvraag. |
| TimePreserveType |
Geeft aan dat de bestaande tijdwaarde ongewijzigd blijft. |
| Operation |
Bewerking is een asynchrone functie die moet worden uitgevoerd en beheerd door Batch. |
| OutgoingHandler |
OutgoingHandler is een asynchrone functie die wordt geactiveerd door BufferScheduler. |
| ReadableStreamGetter | |
Enums
| SASProtocol |
Protocollen voor gegenereerde SAS. |
| RetryPolicyType |
RetryPolicy-typen. |
Functies
| generate |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee wordt een <xref:SASQueryParameters>-object gegenereerd dat alle SAS-queryparameters bevat die nodig zijn om een werkelijke REST-aanvraag te maken. |
| generate |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee maakt u een exemplaar van SASQueryParameters. Accepteert alleen vereiste instellingen die nodig zijn om een SAS te maken. Voor optionele instellingen stelt u de bijbehorende eigenschappen rechtstreeks in, zoals machtigingen, startTime en id. WAARSCHUWING: Wanneer de id niet is opgegeven, zijn machtigingen en vervaldatumtijd vereist. U MOET waarde toewijzen aan id of verlooptijd & machtigingen handmatig als u met deze constructor begint. |
| ip |
Tekenreeks voor IPRange-indeling genereren. Bijvoorbeeld: '8.8.8.8' of '1.1.1.1-255.255.255.255' |
| range |
Genereer een bereiktekenreeks. Bijvoorbeeld: 'bytes=255-' of 'bytes=0-511' |
| upload |
ALLEEN BESCHIKBAAR IN BROWSERS. Uploadt een browserblob/File/ArrayBuffer/ArrayBufferView-object naar een Azure-bestand. |
| download |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Azure-bestand parallel aan een buffer. Verschuiving en aantal zijn optioneel, geef 0 door voor beide om het hele bestand te downloaden. |
| upload |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Uploadt een lokaal bestand naar een Azure-bestand. |
| upload |
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.
Uploadt een Node.js leesbare stroom naar een Azure-bestand.
Met deze methode wordt geprobeerd een Azure te maken en vervolgens segment per segment te uploaden.
De grootte van het segment wordt gedefinieerd door TIPS VOOR PRESTATIEVERBETERING:
|
| file |
|
| file |
|
| file |
|
| validate |
|
| validate |
|
| validate |
|
| New |
Een factorymethode die wordt gebruikt om een RetryPolicy-factory te genereren. |
| blob |
Converteer een Browser Blob-object naar ArrayBuffer. |
| append |
Voeg een tekenreeks toe aan het URL-pad. Hiermee verwijdert u dubbele '/' vóór de tekenreeks wanneer het URL-pad eindigt op een '/'. |
| base64decode(string) | Base64 decoderen. |
| base64encode(string) | Base64-codering. |
| delay(number, Abort |
Vertraging opgegeven tijdsinterval. |
| escape |
Gereserveerde URL-tekens moeten correct worden ontsnapt voor Storage-services, zoals Blob of File. URL-codering en escapestrategie voor JSv10 SDK'sWanneer klanten een URL-tekenreeks doorgeven aan de constructor xxxURL-klassen, is de URL-tekenreeks mogelijk al gecodeerd met een URL of niet. Maar voordat u naar de Azure Storage-server verzendt, moet de URL worden gecodeerd. Het is echter moeilijk voor een SDK om te raden of de URL-tekenreeks al dan niet is gecodeerd. We hebben twee mogelijke strategieën en kiezen strategie twee voor de XXXURL-constructors. Strategie 1: stel dat de tekenreeks van de klant-URL niet is gecodeerd en dat de URL-tekenreeks altijd in SDK wordt gecodeerd.Dit is wat verouderde V2 SDK doet, eenvoudig en werkt voor de meeste gevallen.
Maar deze strategie maakt het niet mogelijk om een blob te maken met '?' in de naam. Omdat wanneer de URL-tekenreeks van de klant 'http://account.blob.core.windows.net/con/blob?name" is, wordt de '?-naam' behandeld als URL-paramter in plaats van blobnaam. Als de url-tekenreeks van de klant 'http://account.blob.core.windows.net/con/blob%3Fname" is, wordt er een blob met de naam 'blob%3Fname' gemaakt. V2 SDK heeft dit probleem niet omdat het niet toestaat dat de klant een volledige URL doorgeeft, er wordt een afzonderlijke blobnaam en codeURIComponent geaccepteerd. We kunnen geen SDK accepteren die geen blobnaam kan maken met '?'. We implementeren dus strategie twee: Strategie 2: sdk gaat er niet van uit dat de URL is gecodeerd of niet. Het zal gewoon ontsnappen aan de speciale tekens.Dit is wat V10 Blob Go SDK doet. Het accepteert een URL-type in Go en roept url aan. EscapedPath() om te ontsnappen aan de speciale tekens die niet zijn gescaped.
Deze strategie biedt ons flexibiliteit om met speciale tekens te maken. Maar "%" wordt behandeld als speciale tekens, als de URL-tekenreeks niet is gecodeerd, mag er geen "%" in de URL-tekenreeks staan, anders is de URL geen geldige URL. Als de klant een blob moet maken met '%' in de blobnaam, gebruikt u "%25" insead of "%". Net als boven het derde voorbeeld. En de volgende URL-tekenreeksen zijn ongeldig:
Een ander speciaal teken is '?' gebruikt u%2F' om een blobnaam weer te geven met '?' in een URL-tekenreeks. Strategie voor containerName, blobName of andere specifieke XXXName-parameters in methoden zoals
|
| get |
URL-parameter ophalen op naam. |
| get |
Url-pad ophalen uit een URL-tekenreeks. |
| get |
Url-querysleutelparen ophalen uit een URL-tekenreeks. |
| pad |
String.prototype.padStart() |
| set |
URL-host instellen. |
| set |
Stel de naam en waarde van de URL-parameter in. Als de naam bestaat in URL-parameters, wordt de oude waarde vervangen door de naamsleutel. Als u geen waarde opgeeft, wordt de parameter verwijderd. |
| truncatedISO8061Date(Date, undefined | false | true) | Rondt een datum af tot seconden. |
| stream |
Leest een leesbare stroom in buffer. Vul de buffer van verschuiving naar einde in. |
Functiedetails
generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee wordt een <xref:SASQueryParameters>-object gegenereerd dat alle SAS-queryparameters bevat die nodig zijn om een werkelijke REST-aanvraag te maken.
function generateAccountSASQueryParameters(accountSASSignatureValues: IAccountSASSignatureValues, sharedKeyCredential: SharedKeyCredential)
Parameters
- accountSASSignatureValues
- IAccountSASSignatureValues
- sharedKeyCredential
- SharedKeyCredential
Retouren
generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee maakt u een exemplaar van SASQueryParameters.
Accepteert alleen vereiste instellingen die nodig zijn om een SAS te maken. Voor optionele instellingen stelt u de bijbehorende eigenschappen rechtstreeks in, zoals machtigingen, startTime en id.
WAARSCHUWING: Wanneer de id niet is opgegeven, zijn machtigingen en vervaldatumtijd vereist. U MOET waarde toewijzen aan id of verlooptijd & machtigingen handmatig als u met deze constructor begint.
function generateFileSASQueryParameters(fileSASSignatureValues: IFileSASSignatureValues, sharedKeyCredential: SharedKeyCredential)
Parameters
- fileSASSignatureValues
- IFileSASSignatureValues
- sharedKeyCredential
- SharedKeyCredential
Retouren
ipRangeToString(IIPRange)
Tekenreeks voor IPRange-indeling genereren. Bijvoorbeeld: '8.8.8.8' of '1.1.1.1-255.255.255.255'
function ipRangeToString(ipRange: IIPRange)
Parameters
- ipRange
- IIPRange
Retouren
string
rangeToString(IRange)
Genereer een bereiktekenreeks. Bijvoorbeeld: 'bytes=255-' of 'bytes=0-511'
function rangeToString(iRange: IRange)
Parameters
- iRange
- IRange
Retouren
string
uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)
ALLEEN BESCHIKBAAR IN BROWSERS. Uploadt een browserblob/File/ArrayBuffer/ArrayBufferView-object naar een Azure-bestand.
function uploadBrowserDataToAzureFile(aborter: Aborter, browserData: Blob | ArrayBuffer | ArrayBufferView, fileURL: FileURL, options?: IUploadToAzureFileOptions)
Parameters
- aborter
- Aborter
Maak een nieuw Aborter-exemplaar met Aborter.none of Aborter.timeout(), ga naar documenten van Aborter voor meer voorbeelden over annulering van aanvragen
- browserData
-
Blob | ArrayBuffer | ArrayBufferView
Blob, File, ArrayBuffer of ArrayBufferView
- fileURL
- FileURL
- options
- IUploadToAzureFileOptions
Retouren
Promise<void>
downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Azure-bestand parallel aan een buffer. Verschuiving en aantal zijn optioneel, geef 0 door voor beide om het hele bestand te downloaden.
function downloadAzureFileToBuffer(aborter: Aborter, buffer: Buffer, fileURL: FileURL, offset: number, count?: undefined | number, options?: IDownloadFromAzureFileOptions)
Parameters
- aborter
- Aborter
Maak een nieuw Aborter-exemplaar met Aborter.none of Aborter.timeout(), ga naar documenten van Aborter voor meer voorbeelden over annulering van aanvragen
- buffer
-
Buffer
Buffer die moet worden gevuld, moet een lengte hebben die groter is dan het aantal
- fileURL
- FileURL
Een FileURL-object
- offset
-
number
Vanaf welke positie van het Azure-bestand u wilt downloaden
- count
-
undefined | number
- options
- IDownloadFromAzureFileOptions
Retouren
Promise<void>
uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Uploadt een lokaal bestand naar een Azure-bestand.
function uploadFileToAzureFile(aborter: Aborter, filePath: string, fileURL: FileURL, options?: IUploadToAzureFileOptions)
Parameters
- aborter
- Aborter
Maak een nieuw Aborter-exemplaar met Aborter.none of Aborter.timeout(), ga naar documenten van Aborter voor meer voorbeelden over annulering van aanvragen
- filePath
-
string
Volledig pad naar het lokale bestand
- fileURL
- FileURL
FileURL
- options
- IUploadToAzureFileOptions
Retouren
Promise<void>
uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)
ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.
Uploadt een Node.js leesbare stroom naar een Azure-bestand.
Met deze methode wordt geprobeerd een Azure te maken en vervolgens segment per segment te uploaden.
De grootte van het segment wordt gedefinieerd door bufferSize parameter.
Zorg ervoor dat de potentiële grootte van de stream niet groter is dan de bestandsgrootte.
TIPS VOOR PRESTATIEVERBETERING:
- Invoerstroom highWaterMark is beter om dezelfde waarde in te stellen met de parameter bufferSize, waardoor buffer.concat() bewerkingen worden vermeden.
function uploadStreamToAzureFile(aborter: Aborter, stream: Readable, size: number, fileURL: FileURL, bufferSize: number, maxBuffers: number, options?: IUploadStreamToAzureFileOptions)
Parameters
- aborter
- Aborter
Maak een nieuw Aborter-exemplaar met Aborter.none of Aborter.timeout(), ga naar documenten van Aborter voor meer voorbeelden over annulering van aanvragen
- stream
-
Readable
Node.js leesbare stroom. Moet kleiner of gelijk zijn aan de bestandsgrootte.
- size
-
number
De grootte van het bestand dat moet worden gemaakt. De toegestane maximale grootte is 1 TB. Als deze waarde groter is dan de stroomgrootte, zijn er lege bytes in de bestandsstaart.
- fileURL
- FileURL
Een FileURL-exemplaar
- bufferSize
-
number
De grootte van elke buffer die is toegewezen in bytes, ook de grootte van het segment/bereik tijdens het geüploade bestand. Grootte moet > 0 en <= 4 * 1024 * 1024 (4 MB)
- maxBuffers
-
number
Maximale buffers worden toegewezen tijdens het uploaden, positieve correlatie met maximale gelijktijdigheid van uploaden
- options
- IUploadStreamToAzureFileOptions
Retouren
Promise<void>
fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)
function fileAttributesToString(fileAttributes: FileSystemAttributes | FileAttributesPreserveType)
Parameters
- fileAttributes
Retouren
string
fileCreationTimeToString(Date | TimeNowType | TimePreserveType)
function fileCreationTimeToString(time: Date | TimeNowType | TimePreserveType)
Parameters
- time
-
Date | TimeNowType | TimePreserveType
Retouren
string
fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)
function fileLastWriteTimeToString(time: Date | TimeNowType | TimePreserveType)
Parameters
- time
-
Date | TimeNowType | TimePreserveType
Retouren
string
validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)
function validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(options: IFileAndDirectoryCreateCommonOptions)
Parameters
Retouren
validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)
function validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(options: IFileAndDirectorySetPropertiesCommonOptions)
Parameters
Retouren
validateFilePermissionOptions(undefined | string, undefined | string)
function validateFilePermissionOptions(filePermission?: undefined | string, filePermissionKey?: undefined | string)
Parameters
- filePermission
-
undefined | string
- filePermissionKey
-
undefined | string
NewRetryPolicyFactory(IRetryOptions)
Een factorymethode die wordt gebruikt om een RetryPolicy-factory te genereren.
function NewRetryPolicyFactory(retryOptions?: IRetryOptions)
Parameters
- retryOptions
- IRetryOptions
Retouren
RequestPolicyFactory
blobToArrayBuffer(Blob)
Converteer een Browser Blob-object naar ArrayBuffer.
function blobToArrayBuffer(blob: Blob)
Parameters
- blob
-
Blob
Retouren
Promise<ArrayBuffer>
appendToURLPath(string, string)
Voeg een tekenreeks toe aan het URL-pad. Hiermee verwijdert u dubbele '/' vóór de tekenreeks wanneer het URL-pad eindigt op een '/'.
function appendToURLPath(url: string, name: string)
Parameters
- url
-
string
Bron-URL-tekenreeks
- name
-
string
Tekenreeks die moet worden toegevoegd aan URL
Retouren
string
Een bijgewerkte URL-tekenreeks
base64decode(string)
Base64 decoderen.
function base64decode(encodedString: string)
Parameters
- encodedString
-
string
Retouren
string
base64encode(string)
Base64-codering.
function base64encode(content: string)
Parameters
- content
-
string
Retouren
string
delay(number, AbortSignalLike, Error)
Vertraging opgegeven tijdsinterval.
function delay(timeInMs: number, aborter?: AbortSignalLike, abortError?: Error)
Parameters
- timeInMs
-
number
- aborter
-
AbortSignalLike
- abortError
-
Error
Retouren
Promise<unknown>
escapeURLPath(string)
Gereserveerde URL-tekens moeten correct worden ontsnapt voor Storage-services, zoals Blob of File.
URL-codering en escapestrategie voor JSv10 SDK's
Wanneer klanten een URL-tekenreeks doorgeven aan de constructor xxxURL-klassen, is de URL-tekenreeks mogelijk al gecodeerd met een URL of niet. Maar voordat u naar de Azure Storage-server verzendt, moet de URL worden gecodeerd. Het is echter moeilijk voor een SDK om te raden of de URL-tekenreeks al dan niet is gecodeerd. We hebben twee mogelijke strategieën en kiezen strategie twee voor de XXXURL-constructors.
Strategie 1: stel dat de tekenreeks van de klant-URL niet is gecodeerd en dat de URL-tekenreeks altijd in SDK wordt gecodeerd.
Dit is wat verouderde V2 SDK doet, eenvoudig en werkt voor de meeste gevallen.
- Wanneer de URL-tekenreeks van de klant ishttp://account.blob.core.windows.net/con/b:", wordt deze door SDK gecodeerd naarhttp://account.blob.core.windows.net/con/b%3A" en verzenden naar de server. Er wordt een blob met de naam 'b:' gemaakt.
- Wanneer de URL-tekenreeks van de klant ishttp://account.blob.core.windows.net/con/b%3A", wordt deze door SDK gecodeerd naarhttp://account.blob.core.windows.net/con/b%253A" en verzenden naar de server. Er wordt een blob met de naam b%3Agemaakt.
Maar deze strategie maakt het niet mogelijk om een blob te maken met '?' in de naam. Omdat wanneer de URL-tekenreeks van de klant 'http://account.blob.core.windows.net/con/blob?name" is, wordt de '?-naam' behandeld als URL-paramter in plaats van blobnaam. Als de url-tekenreeks van de klant 'http://account.blob.core.windows.net/con/blob%3Fname" is, wordt er een blob met de naam 'blob%3Fname' gemaakt. V2 SDK heeft dit probleem niet omdat het niet toestaat dat de klant een volledige URL doorgeeft, er wordt een afzonderlijke blobnaam en codeURIComponent geaccepteerd. We kunnen geen SDK accepteren die geen blobnaam kan maken met '?'. We implementeren dus strategie twee:
Strategie 2: sdk gaat er niet van uit dat de URL is gecodeerd of niet. Het zal gewoon ontsnappen aan de speciale tekens.
Dit is wat V10 Blob Go SDK doet. Het accepteert een URL-type in Go en roept url aan. EscapedPath() om te ontsnappen aan de speciale tekens die niet zijn gescaped.
- Wanneer de tekenreeks van de url van de klanthttp://account.blob.core.windows.net/con/b:"is, escapet SDK ':' like 'http://account.blob.core.windows.net/con/b%3A" en verzenden naar de server. Er wordt een blob met de naam 'b:' gemaakt.
- Wanneer de tekenreeks voor de URL van de klant "http://account.blob.core.windows.net/con/b%3A" is, zijn er geen speciale tekens, dus verzenden "http://account.blob.core.windows.net/con/b%3A" naar server. Er wordt een blob met de naam 'b:' gemaakt.
- Wanneer de tekenreeks voor de URL van de klant "http://account.blob.core.windows.net/con/b%253A" is, zijn er geen speciale tekens, dus verzenden "http://account.blob.core.windows.net/con/b%253A" naar server. Er wordt een blob met de naam b%3Agemaakt.
Deze strategie biedt ons flexibiliteit om met speciale tekens te maken. Maar "%" wordt behandeld als speciale tekens, als de URL-tekenreeks niet is gecodeerd, mag er geen "%" in de URL-tekenreeks staan, anders is de URL geen geldige URL. Als de klant een blob moet maken met '%' in de blobnaam, gebruikt u "%25" insead of "%". Net als boven het derde voorbeeld. En de volgende URL-tekenreeksen zijn ongeldig:
- "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"
Een ander speciaal teken is '?' gebruikt u%2F' om een blobnaam weer te geven met '?' in een URL-tekenreeks.
Strategie voor containerName, blobName of andere specifieke XXXName-parameters in methoden zoals BlobURL.fromContainerURL(containerURL, blobName)
We passen strategie één toe en roepen codeURIComponent aan voor deze parameters, zoals blobName. Omdat wat klanten doorgeven een gewone naam is in plaats van een URL.
function escapeURLPath(url: string)
Parameters
- url
-
string
Retouren
string
getURLParameter(string, string)
URL-parameter ophalen op naam.
function getURLParameter(url: string, name: string)
Parameters
- url
-
string
- name
-
string
Retouren
string | string[] | undefined
getURLPath(string)
Url-pad ophalen uit een URL-tekenreeks.
function getURLPath(url: string)
Parameters
- url
-
string
Bron-URL-tekenreeks
Retouren
string | undefined
getURLQueries(string)
Url-querysleutelparen ophalen uit een URL-tekenreeks.
function getURLQueries(url: string)
Parameters
- url
-
string
Retouren
[key: string]: string
padStart(string, number, undefined | string)
String.prototype.padStart()
function padStart(currentString: string, targetLength: number, padString?: undefined | string)
Parameters
- currentString
-
string
- targetLength
-
number
- padString
-
undefined | string
Retouren
string
setURLHost(string, string)
URL-host instellen.
function setURLHost(url: string, host: string)
Parameters
- url
-
string
Bron-URL-tekenreeks
- host
-
string
Nieuwe hosttekenreeks
Retouren
string
Een bijgewerkte URL-tekenreeks
setURLParameter(string, string, undefined | string)
Stel de naam en waarde van de URL-parameter in. Als de naam bestaat in URL-parameters, wordt de oude waarde vervangen door de naamsleutel. Als u geen waarde opgeeft, wordt de parameter verwijderd.
function setURLParameter(url: string, name: string, value?: undefined | string)
Parameters
- url
-
string
Bron-URL-tekenreeks
- name
-
string
Parameternaam
- value
-
undefined | string
Retouren
string
Een bijgewerkte URL-tekenreeks
truncatedISO8061Date(Date, undefined | false | true)
Rondt een datum af tot seconden.
function truncatedISO8061Date(date: Date, withMilliseconds?: undefined | false | true)
Parameters
- date
-
Date
- withMilliseconds
-
undefined | false | true
Retouren
string
Datumtekenreeks in ISO8061 indeling, met of zonder 7 milliseconden
streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)
Leest een leesbare stroom in buffer. Vul de buffer van verschuiving naar einde in.
function streamToBuffer(stream: ReadableStream, buffer: Buffer, offset: number, end: number, encoding?: undefined | string)
Parameters
- stream
-
ReadableStream
Een Node.js leesbare stream
- buffer
-
Buffer
Buffer die moet worden opgevuld, lengte moet >= verschuiving
- offset
-
number
Vanaf welke positie in de buffer moet worden gevuld, inclusief
- end
-
number
Naar welke positie in de buffer moet worden gevuld, exclusief
- encoding
-
undefined | string
Retouren
Promise<void>