Skip to content

Commit

Permalink
chore: fix typo in readme (#27)
Browse files Browse the repository at this point in the history
  • Loading branch information
jazzdan authored May 23, 2021
1 parent e851dc2 commit 83ea6e4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ await bucket.putObject("test", encoder.encode("Test1"), {
contentType: "text/plain",
});

// Retrieve an object form a bucket.
// Retrieve an object from a bucket.
const { body } = await bucket.getObject("test");
const data = await new Response(body).text();
console.log("File 'test' contains:", data);
Expand Down
12 changes: 6 additions & 6 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export interface S3Object {
*/
lastModified?: Date;
/**
* The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below: Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data. Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data. If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.
* The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below: Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data. Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data. If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.
*/
eTag?: string;
/**
Expand Down Expand Up @@ -113,7 +113,7 @@ export interface HeadObjectResponse {
/** Specifies presentational information for the object. */
contentDisposition?: string;

/**
/**
* Specifies what content encodings have been applied to the object
* and thus what decoding mechanisms must be applied to obtain the
* media-type referenced by the Content-Type field.
Expand Down Expand Up @@ -241,15 +241,15 @@ export interface ListObjectsResponse {
*/
maxKeys?: number;
/**
* All of the keys rolled up into a common prefix count as a single return when calculating the number of returns. A response can contain CommonPrefixes only if you specify a delimiter. CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
* All of the keys rolled up into a common prefix count as a single return when calculating the number of returns. A response can contain CommonPrefixes only if you specify a delimiter. CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
*/
commonPrefixes?: CommonPrefix[];
/**
* Encoding type used by Amazon S3 to encode object key names in the XML response. If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements: Delimiter, Prefix, Key, and StartAfter.
*/
encodingType?: string;
/**
* KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys
* KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys
*/
keyCount?: number;
/**
Expand Down Expand Up @@ -330,7 +330,7 @@ export interface PutObjectOptions {
/** Specifies presentational information for the object. */
contentDisposition?: string;

/**
/**
* Specifies what content encodings have been applied to the object
* and thus what decoding mechanisms must be applied to obtain the
* media-type referenced by the Content-Type field.
Expand Down Expand Up @@ -422,7 +422,7 @@ export interface CopyObjectOptions {
/** Specifies presentational information for the object. */
contentDisposition?: string;

/**
/**
* Specifies what content encodings have been applied to the object
* and thus what decoding mechanisms must be applied to obtain the
* media-type referenced by the Content-Type field.
Expand Down

0 comments on commit 83ea6e4

Please sign in to comment.