<commit_before>/* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0

ABOUT NODE.JS EXAMPLES: The examples works with Version 3 (v3) of the AWS SDK for JavaScript,
which is scheduled for release later in 2020. The prerelease version of the version 3 of the SDK is available `here <at https://github.com/aws/aws-sdk-js-v3>`_ .
The 'SDK for JavaScript Developer Guide' for V3 is also scheduled for release later in 2020, and the topic containing this example will be hosted
`here <https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sqs-examples-managing-visibility-timeout.html`_ .

###############################
AWS SDK for JavaScript version 3 (v3) examples
###############################

These are examples for the AWS SDK for JavaScript (v3) public documentation.

**NOTE:** The AWS SDK for JavaScript (v3) is written in TypeScript so, for consistency, these examples are also in TypeScript. TypeScript extends of JavaScript so these examples can also be run as JavaScript.

Prerequisites
=============

To build and run these examples, you'll need:

- Set up the project environment to run these Node TypeScript examples, and install the required AWS SDK for JavaScript and third-party modules. Follow the instructions on in the README.md in the folder with the examples you're running. For for example, for an s3 example use the instructions `here <https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/javascriptv3/example_code/s3/README.md>`_.
- Create a shared configurations file with your user credentials. For more information about providing a shared credentials file, see `Loading credentials in Node.js from the shared credentials file <https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-shared.html>`_ (release pending).

Running the examples
====================

Examples are written for either execution in a browser script or in Node.js, usually depending on the use case for each. The two scenarios typically differ in how you supply credentials to the code. These differences are described in the Developer Guide at `here <https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-credentials.html>`_ (release pending).

To run the examples, you'll need to create a shared credentials file. For more information about how to set up a shared credentials file,
see `Loading Credentials in Node.js from the Shared Credentials File <https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-shared.html>`_
in the *AWS SDK for JavaScript Developer Guide*.

The Node.js examples are all run from the command line.

Documentation
=============

You can find detailed documentation for the AWS SDK for JavaScript at:

- `AWS SDK for JavaScript Developer Guide <http://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide>`_
 (release pending)
- `AWS SDK for JavaScript API Reference <http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html>`_<commit_msg>updated READMEs<commit_after>Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0

ABOUT NODE.JS EXAMPLES: The examples works with Version 3 (v3) of the AWS SDK for JavaScript,
which is scheduled for release later in 2020. The prerelease version of the version 3 of the SDK is available `here <at https://github.com/aws/aws-sdk-js-v3>`_ .
The 'SDK for JavaScript Developer Guide' for V3 is also scheduled for release later in 2020, and the topic containing this example will be hosted
`here <https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sqs-examples-managing-visibility-timeout.html`_ .

###############################
AWS SDK for JavaScript version 3 (v3) examples
###############################

These are examples for the AWS SDK for JavaScript (v3) public documentation.

**NOTE:** The AWS SDK for JavaScript (v3) is written in TypeScript so, for consistency, these examples are also in TypeScript. TypeScript extends of JavaScript so these examples can also be run as JavaScript.

Prerequisites
=============

To build and run these examples, you'll need:

- Set up the project environment to run these Node TypeScript examples, and install the required AWS SDK for JavaScript and third-party modules. Follow the instructions on in the README.md in the folder with the examples you're running. For for example, for an s3 example use the instructions `here <https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/javascriptv3/example_code/s3/README.md>`_.
- Create a shared configurations file with your user credentials. For more information about providing a shared credentials file, see `Loading credentials in Node.js from the shared credentials file <https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-shared.html>`_ (release pending).

Running the examples
====================

Examples are written for either execution in a browser script or in Node.js, usually depending on the use case for each. The two scenarios typically differ in how you supply credentials to the code. These differences are described in the Developer Guide at `here <https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-credentials.html>`_ (release pending).

To run the examples, you'll need to create a shared credentials file. For more information about how to set up a shared credentials file,
see `Loading Credentials in Node.js from the Shared Credentials File <https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-shared.html>`_
in the *AWS SDK for JavaScript Developer Guide*.

The Node.js examples are all run from the command line.

Documentation
=============

You can find detailed documentation for the AWS SDK for JavaScript at:

- `AWS SDK for JavaScript Developer Guide <http://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide>`_(release pending)
- `AWS SDK for JavaScript API Reference <http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html>`_
{'fraction_non_alphanumeric': 0.1101430215354266, 'fraction_numerical': 0.008877198750616473, 'mean_word_length': 4.861271676300578, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 17, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '507364', 'n_tokens_mistral': 1667, 'n_tokens_neox': 1544, 'n_words': 702}