{"id":45646,"library":"oci-queue","title":"OCI Queue Node.js Client","description":"Official Oracle Cloud Infrastructure (OCI) Node.js SDK client for the Queue service, version 2.132.0. This module enables management of Queue resources (create, update, delete queues and messages) via OCI APIs. It follows the monthly release cadence of the OCI TypeScript SDK and requires OCI authentication (API key, instance principal, etc.). Compared to lower-level REST calls, this SDK provides typed interfaces, automatic request signing, and integration with OCI identity and IAM policies. It ships TypeScript types and supports both ESM and CJS.","status":"active","version":"2.132.0","language":"javascript","source_language":"en","source_url":"https://github.com/oracle/oci-typescript-sdk","tags":["javascript","typescript"],"install":[{"cmd":"npm install oci-queue","lang":"bash","label":"npm"},{"cmd":"yarn add oci-queue","lang":"bash","label":"yarn"},{"cmd":"pnpm add oci-queue","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Core authentication and HTTP signing utilities required by all OCI service clients","package":"oci-common","optional":false},{"reason":"Provides types and helpers for authentication providers (e.g., ResourcePrincipalAuthenticationDetailsProvider)","package":"oci-identity","optional":true}],"imports":[{"note":"Works in both ESM and CJS, but named import is preferred for tree-shaking.","wrong":"const QueueClient = require('oci-queue').QueueClient","symbol":"QueueClient","correct":"import { QueueClient } from 'oci-queue'"},{"note":"models namespace is not exported from the main entry; you must import from the specific subpath.","wrong":"import { models } from 'oci-queue'","symbol":"models","correct":"import * as models from 'oci-queue/lib/models'"},{"note":"Model types are in 'oci-queue/lib/models'. Direct import from 'oci-queue' does not re-export them.","wrong":"import { UpdateQueueDetails } from 'oci-queue'","symbol":"UpdateQueueDetails","correct":"import { UpdateQueueDetails } from 'oci-queue/lib/models'"}],"quickstart":{"code":"import { QueueClient } from 'oci-queue';\nimport common from 'oci-common';\n\n// Set up authentication provider\nconst provider = new common.ConfigFileAuthenticationDetailsProvider();\n// Or use Instance Principals:\n// const provider = new common.InstancePrincipalsAuthenticationDetailsProvider();\n\n// Create a client for the Queue service\nconst client = new QueueClient({ authenticationDetailsProvider: provider });\n\nasync function listQueues() {\n  // Replace with your compartment OCID\n  const compartmentId = process.env.OCI_COMPARTMENT_ID ?? '';\n  try {\n    const response = await client.listQueues({ compartmentId });\n    console.log('Queues:', response.items);\n  } catch (error) {\n    console.error('Error listing queues:', error);\n  }\n}\n\nlistQueues();","lang":"typescript","description":"Demonstrates how to authenticate and list queues using the OCI Queue client."},"warnings":[{"fix":"Create a provider using 'new common.ConfigFileAuthenticationDetailsProvider()' and pass it in the constructor.","message":"In v2.x, the client constructor now requires an explicit authenticationDetailsProvider object. Passing only a config file path without creating a provider is no longer supported.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Replace client.deleteQueue(queueId) with client.deleteQueueWithResponse({ queueId }).","message":"The method 'deleteQueue' is deprecated; use 'deleteQueueWithResponse' instead.","severity":"deprecated","affected_versions":">=2.50.0"},{"fix":"npm install oci-identity and import 'InstancePrincipalsAuthenticationDetailsProvider' from 'oci-common' (it is re-exported).","message":"When using Instance Principals, you must also install 'oci-identity' for the provider.","severity":"gotcha","affected_versions":">=2.0.0"},{"fix":"Import from the subpath: 'import { UpdateQueueDetails } from 'oci-queue/lib/models'.","message":"Model types (e.g., UpdateQueueDetails) are not re-exported from the main package entry point. Attempting 'import { UpdateQueueDetails } from 'oci-queue'' will result in undefined.","severity":"gotcha","affected_versions":">=2.0.0"},{"fix":"Replace 'oci-common' with 'oci-common-sdk' and update imports accordingly.","message":"The 'oci-common' package is being deprecated in favor of 'oci-common-sdk'. Migrate to the new package for future updates.","severity":"deprecated","affected_versions":">=2.100.0"}],"env_vars":null,"search_vec":"'2.132.0':18 'api':34,50 'authent':49 'automat':67 'cadenc':40 'call':61 'cjs':87 'client':4,12 'cloud':7 'compar':55 'creat':26 'delet':28 'enabl':21 'esm':85 'etc':54 'follow':36 'iam':76 'ident':74 'infrastructur':8 'instanc':52 'integr':71 'interfac':66 'javascript':88 'key':51 'level':59 'lower':58 'lower-level':57 'manag':22 'messag':31 'modul':20 'month':38 'node.js':3,10 'oci':1,9,33,43,48,73 'offici':5 'oracl':6 'polici':77 'princip':53 'provid':64 'queue':2,15,24,29 'releas':39 'request':68 'requir':47 'resourc':25 'rest':60 'sdk':11,45,63 'servic':16 'ship':79 'sign':69 'support':83 'type':65,81 'typescript':44,80,89 'updat':27 'version':17 'via':32","created_at":"2026-06-07T12:56:02.424480+00:00","updated_at":"2026-06-07T12:56:02.424480+00:00","problems":[{"fix":"Instantiate a provider (e.g., new common.ConfigFileAuthenticationDetailsProvider()) and pass it in the options object.","cause":"The client constructor was called without a valid authenticationDetailsProvider.","error":"Error: No authentication details provider found. Please provide one."},{"fix":"Check response.error or wrap the call in a try-catch. Use response.items only on success.","cause":"The response object from listQueues does not contain 'items' because the request failed and returned an error object.","error":"TypeError: Cannot read properties of undefined (reading 'items')"},{"fix":"Verify the exact model name by checking the SDK documentation or the installed package's lib/models directory.","cause":"Import path is incorrect or the model does not exist in that subpath.","error":"Model 'model' not found in 'oci-queue/lib/models'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/oracle/oci-typescript-sdk#readme","github":"https://github.com/oracle/oci-typescript-sdk","docs":null,"changelog":null,"pypi":null,"npm":"oci-queue","openapi_spec":null,"status_page":null,"smithery":null,"categories":["messaging"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-07","next_check":"2026-09-05","install_tag":null}}