Namely, Pickled Meatballs

    oci-sdk
    TypeScript icon, indicating that this package has built-in type declarations

    2.38.0 • Public • Published

    Oracle Cloud Infrastructure SDK for TypeScript and JavaScript

    wercker status

    This is Oracle Cloud Infrastructure SDK for TypeScript and JavaScript. This project is open source and maintained by Oracle Corp. The home page for the project is Oracle Cloud Infrastructure SDK for TypeScript and JavaScript.

    Feedback

    Are you a Developer using the OCI SDK? If so, please fill out our survey to help us make the OCI SDK better for you. Click here.

    Installing

    Use the following command to install this SDK:

    npm install oci-sdk
    

    Alternatively you can git clone this repo.

    Working with the SDK for TypeScript and JavaScript

    To start working with the SDK for TypeScript and JavaScript, you import the service package, create a client, and then use that client to make calls. Refer to examples section for examples on how to make requests.

    Configuring

    Before using the SDK, set up a config file with the required credentials. See SDK and Tool Configuration for instructions.

    Organization of the SDK

    The oci-typescript-sdk contains the following:

    • Service packages: All packages except common and any other package found inside lib. These packages represent the Oracle Cloud Infrastructure services supported by the SDK for TypeScript and JavaScript. Each package represents a service. These packages include methods to interact with the service, structs that model input and output parameters, and a client struct that acts as receiver for the above methods.

    • Common package: Found in the common directory. The common package provides supporting functions and structs used by service packages. Includes HTTP request/response (de)serialization, request signing, JSON parsing, pointer to reference and other helper functions. Most of the functions in this package are meant to be used by the service packages.

    Examples

    Examples can be found in the examples section

    Documentation

    Full documentation can be found on the sdk for typescript and javascript documentation site.

    Versions Supported

    The SDK for TypeScript and JavaScript currently supports NodeJS version 14 & 16 and TypeScript version 4.1.3.

    Node & Browser Support

    The SDK for TypeScript and JavaScript currently supports NodeJS but does not have browser support.

    Help

    Contributing

    oci-typescript-sdk is an open source project. See CONTRIBUTING for details.

    Oracle gratefully acknowledges the contributions to oci-typescript-sdk that have been made by the community.

    License

    Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved. This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.

    See LICENSE for more details.

    Changes

    See CHANGELOG.

    Known Issues

    • You can find information on any known issues with the SDK at Oracle Cloud Infrastructure Known Issues and under the Issues tab of this project's GitHub repository.
    • JavaScript numbers have rounding issues for number greater than Number.MAX_SAFE_INTEGER, APIs with responses that contain number greater than Number.MAX_SAFE_INTEGER may result in rounding issues.

    Keywords

    none

    Install

    npm i oci-sdk

    DownloadsWeekly Downloads

    2,245

    Version

    2.38.0

    License

    (UPL-1.0 OR Apache-2.0)

    Unpacked Size

    63.8 kB

    Total Files

    8

    Last publish

    Collaborators

    • jsaini
    • waruto
    • yashchan
    • oci-dex-release-bot