From ece3465093090e622a9749380740962ec6319635 Mon Sep 17 00:00:00 2001 From: Lordfirespeed <28568841+Lordfirespeed@users.noreply.github.com> Date: Tue, 20 Aug 2024 17:06:52 +0100 Subject: [PATCH] docs: amend docstring for `splitMultipart` --- src/utils/split-multipart.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/utils/split-multipart.ts b/src/utils/split-multipart.ts index 4f26e7f..6b895af 100644 --- a/src/utils/split-multipart.ts +++ b/src/utils/split-multipart.ts @@ -17,7 +17,8 @@ function fail(): never { } /** - * Split a buffer's contents by some delimiter. + * Split a buffer containing multipart/* contents by the specified boundary according to + * [RFC 2026 Multipart Media Type]{@link https://datatracker.ietf.org/doc/html/rfc2046#section-5.1}. * * Returns an array of new {@link Buffer} objects that reference the same memory as the original, * but offset and cropped appropriately.