@azure/communication-common - npm Package Compare versions

Comparing version 1.0.0-alpha.20210205.1 to 1.0.0-alpha.20210209.1

dist-esm/src/communicationTokenCredential.js

@@ -22,3 +22,3 @@ // Copyright (c) Microsoft Corporation.
      * Gets an `AccessToken` for the user. Throws if already disposed.
-     * @param abortSignal An implementation of `AbortSignalLike` to cancel the operation.
+     * @param abortSignal - An implementation of `AbortSignalLike` to cancel the operation.
      */
@@ -25,0 +25,0 @@ getToken(abortSignal) {

dist-esm/src/credential/clientArguments.js

@@ -22,3 +22,3 @@ // Copyright (c) Microsoft Corporation.
  *
- * @param {*} credential The credential being checked.
+ * @param credential - The credential being checked.
  */
@@ -31,4 +31,4 @@ export const isKeyCredential = (credential) => {
  *
- * @param {string} connectionStringOrUrl
- * @param {*} [credentialOrOptions]
+ * @param connectionStringOrUrl
+ * @param [credentialOrOptions]
  */
@@ -35,0 +35,0 @@ export const parseClientArguments = (connectionStringOrUrl, credentialOrOptions) => {

dist-esm/src/credential/communicationAccessKeyCredentialPolicy.js

@@ -10,3 +10,3 @@ // Copyright (c) Microsoft Corporation.
  *
- * @param {KeyCredential} credential The key credential
+ * @param credential - The key credential
  */
@@ -28,3 +28,3 @@ export const createCommunicationAccessKeyCredentialPolicy = (credential) => {
      * using a base64 encoded key.
-     * @param accessKey The base64 encoded key to be used for signing.
+     * @param accessKey - The base64 encoded key to be used for signing.
      */
@@ -38,3 +38,3 @@ constructor(accessKey, nextPolicy, options) {
      *
-     * @param {WebResource} webResource The WebResource to be signed.
+     * @param webResource - The WebResource to be signed.
      */
@@ -67,3 +67,3 @@ signRequest(webResource) {
      *
-     * @param {WebResourceLike} webResource
+     * @param webResource
      */
@@ -70,0 +70,0 @@ sendRequest(webResource) {

dist-esm/src/credential/communicationAuthPolicy.js

@@ -8,3 +8,3 @@ import { isTokenCredential } from "@azure/core-auth";
  *
- * @param {KeyCredential | TokenCredential} credential The key credential
+ * @param credential - The key credential
  */
@@ -11,0 +11,0 @@ export const createCommunicationAuthPolicy = (credential) => {

dist-esm/src/credential/connectionString.js

@@ -16,3 +16,3 @@ // Copyright (c) Microsoft Corporation.
  *
- * @param {string} connectionString The connection string to parse
+ * @param connectionString - The connection string to parse
  * @returns {EndpointCredential} Object to access the endpoint and the credenials
@@ -19,0 +19,0 @@ */

dist-esm/src/identifierModels.js

@@ -6,3 +6,3 @@ // Copyright (c) Microsoft Corporation.
  *
- * @param identifier The assumed CommunicationUserIdentifier to be tested.
+ * @param identifier - The assumed CommunicationUserIdentifier to be tested.
  */
@@ -15,3 +15,3 @@ export const isCommunicationUserIdentifier = (identifier) => {
  *
- * @param identifier The assumed PhoneNumberIdentifier to be tested.
+ * @param identifier - The assumed PhoneNumberIdentifier to be tested.
  */
@@ -24,3 +24,3 @@ export const isPhoneNumberIdentifier = (identifier) => {
  *
- * @param identifier The assumed available to be tested.
+ * @param identifier - The assumed available to be tested.
  */
@@ -33,3 +33,3 @@ export const isMicrosoftTeamsUserIdentifier = (identifier) => {
  *
- * @param identifier The assumed UnknownIdentifier to be tested.
+ * @param identifier - The assumed UnknownIdentifier to be tested.
  */
@@ -42,3 +42,3 @@ export const isUnknownIdentifier = (identifier) => {
  *
- * @param identifier The identifier whose kind is to be inferred.
+ * @param identifier - The identifier whose kind is to be inferred.
  */
@@ -45,0 +45,0 @@ export const getIdentifierKind = (identifier) => {

dist-esm/src/identifierModelSerializer.js

@@ -8,3 +8,3 @@ // Copyright (c) Microsoft Corporation.
  * Translates a CommunicationIdentifier to its serialized format for sending a request.
- * @param identifier The CommunicationIdentifier to be serialized.
+ * @param identifier - The CommunicationIdentifier to be serialized.
  */
@@ -36,3 +36,3 @@ export const _serializeCommunicationIdentifier = (identifier) => {
  * Translates the serialized format of a communication identifier to CommunicationIdentifier.
- * @param serializedIdentifier The SerializedCommunicationIdentifier to be deserialized.
+ * @param serializedIdentifier - The SerializedCommunicationIdentifier to be deserialized.
  */
@@ -39,0 +39,0 @@ export const _deserializeCommunicationIdentifier = (serializedIdentifier) => {

dist/index.js

@@ -149,3 +149,3 @@ 'use strict';
      * Gets an `AccessToken` for the user. Throws if already disposed.
-     * @param abortSignal An implementation of `AbortSignalLike` to cancel the operation.
+     * @param abortSignal - An implementation of `AbortSignalLike` to cancel the operation.
      */
@@ -192,3 +192,3 @@ getToken(abortSignal) {
  *
- * @param {KeyCredential} credential The key credential
+ * @param credential - The key credential
  */
@@ -210,3 +210,3 @@ const createCommunicationAccessKeyCredentialPolicy = (credential) => {
      * using a base64 encoded key.
-     * @param accessKey The base64 encoded key to be used for signing.
+     * @param accessKey - The base64 encoded key to be used for signing.
      */
@@ -220,3 +220,3 @@ constructor(accessKey, nextPolicy, options) {
      *
-     * @param {WebResource} webResource The WebResource to be signed.
+     * @param webResource - The WebResource to be signed.
      */
@@ -249,3 +249,3 @@ signRequest(webResource) {
      *
-     * @param {WebResourceLike} webResource
+     * @param webResource
      */
@@ -266,3 +266,3 @@ sendRequest(webResource) {
  *
- * @param {KeyCredential | TokenCredential} credential The key credential
+ * @param credential - The key credential
  */
@@ -291,3 +291,3 @@ const createCommunicationAuthPolicy = (credential) => {
  *
- * @param {string} connectionString The connection string to parse
+ * @param connectionString - The connection string to parse
  * @returns {EndpointCredential} Object to access the endpoint and the credenials
@@ -322,3 +322,3 @@ */
  *
- * @param {*} credential The credential being checked.
+ * @param credential - The credential being checked.
  */
@@ -331,4 +331,4 @@ const isKeyCredential = (credential) => {
  *
- * @param {string} connectionStringOrUrl
- * @param {*} [credentialOrOptions]
+ * @param connectionStringOrUrl
+ * @param [credentialOrOptions]
  */
@@ -352,3 +352,3 @@ const parseClientArguments = (connectionStringOrUrl, credentialOrOptions) => {
  *
- * @param identifier The assumed CommunicationUserIdentifier to be tested.
+ * @param identifier - The assumed CommunicationUserIdentifier to be tested.
  */
@@ -361,3 +361,3 @@ const isCommunicationUserIdentifier = (identifier) => {
  *
- * @param identifier The assumed PhoneNumberIdentifier to be tested.
+ * @param identifier - The assumed PhoneNumberIdentifier to be tested.
  */
@@ -370,3 +370,3 @@ const isPhoneNumberIdentifier = (identifier) => {
  *
- * @param identifier The assumed available to be tested.
+ * @param identifier - The assumed available to be tested.
  */
@@ -379,3 +379,3 @@ const isMicrosoftTeamsUserIdentifier = (identifier) => {
  *
- * @param identifier The assumed UnknownIdentifier to be tested.
+ * @param identifier - The assumed UnknownIdentifier to be tested.
  */
@@ -388,3 +388,3 @@ const isUnknownIdentifier = (identifier) => {
  *
- * @param identifier The identifier whose kind is to be inferred.
+ * @param identifier - The identifier whose kind is to be inferred.
  */
@@ -408,3 +408,3 @@ const getIdentifierKind = (identifier) => {
  * Translates a CommunicationIdentifier to its serialized format for sending a request.
- * @param identifier The CommunicationIdentifier to be serialized.
+ * @param identifier - The CommunicationIdentifier to be serialized.
  */
@@ -436,3 +436,3 @@ const _serializeCommunicationIdentifier = (identifier) => {
  * Translates the serialized format of a communication identifier to CommunicationIdentifier.
- * @param serializedIdentifier The SerializedCommunicationIdentifier to be deserialized.
+ * @param serializedIdentifier - The SerializedCommunicationIdentifier to be deserialized.
  */
@@ -439,0 +439,0 @@ const _deserializeCommunicationIdentifier = (serializedIdentifier) => {

package.json

 {
   "name": "@azure/communication-common",
-  "version": "1.0.0-alpha.20210205.1",
+  "version": "1.0.0-alpha.20210209.1",
   "description": "Common package for Azure Communication services.",
@@ -5,0 +5,0 @@ "sdk-type": "client",

types/communication-common.d.ts

@@ -15,3 +15,3 @@ import { AbortSignalLike } from '@azure/core-http';
      * Creates an instance of CommunicationTokenCredential with a static token and no proactive refreshing.
-     * @param token A user access token issued by Communication Services.
+     * @param token - A user access token issued by Communication Services.
      */
@@ -22,3 +22,3 @@ constructor(token: string);
      * to configure proactive refreshing.
-     * @param refreshOptions Options to configure refresh and opt-in to proactive refreshing.
+     * @param refreshOptions - Options to configure refresh and opt-in to proactive refreshing.
      */
@@ -28,3 +28,3 @@ constructor(refreshOptions: CommunicationTokenRefreshOptions);
      * Gets an `AccessToken` for the user. Throws if already disposed.
-     * @param abortSignal An implementation of `AbortSignalLike` to cancel the operation.
+     * @param abortSignal - An implementation of `AbortSignalLike` to cancel the operation.
      */
@@ -55,3 +55,3 @@ getToken(abortSignal?: AbortSignalLike): Promise<AccessToken>;
      * Gets an `AccessToken` for the user. Throws if already disposed.
-     * @param abortSignal An implementation of `AbortSignalLike` to cancel the operation.
+     * @param abortSignal - An implementation of `AbortSignalLike` to cancel the operation.
      */
@@ -108,3 +108,3 @@ getToken(abortSignal?: AbortSignalLike): Promise<AccessToken>;
  *
- * @param {KeyCredential} credential The key credential
+ * @param credential - The key credential
  */
@@ -117,3 +117,3 @@ export declare const createCommunicationAccessKeyCredentialPolicy: (credential: KeyCredential) => RequestPolicyFactory;
  *
- * @param {KeyCredential | TokenCredential} credential The key credential
+ * @param credential - The key credential
  */
@@ -142,3 +142,3 @@ export declare const createCommunicationAuthPolicy: (credential: KeyCredential | TokenCredential) => RequestPolicyFactory;
  *
- * @param identifier The identifier whose kind is to be inferred.
+ * @param identifier - The identifier whose kind is to be inferred.
  */
@@ -150,3 +150,3 @@ export declare const getIdentifierKind: (identifier: CommunicationIdentifier) => CommunicationIdentifierKind;
  *
- * @param identifier The assumed CommunicationUserIdentifier to be tested.
+ * @param identifier - The assumed CommunicationUserIdentifier to be tested.
  */
@@ -158,3 +158,3 @@ export declare const isCommunicationUserIdentifier: (identifier: CommunicationIdentifier) => identifier is CommunicationUserIdentifier;
  *
- * @param {*} credential The credential being checked.
+ * @param credential - The credential being checked.
  */
@@ -166,3 +166,3 @@ export declare const isKeyCredential: (credential: any) => credential is KeyCredential;
  *
- * @param identifier The assumed available to be tested.
+ * @param identifier - The assumed available to be tested.
  */
@@ -174,3 +174,3 @@ export declare const isMicrosoftTeamsUserIdentifier: (identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsUserIdentifier;
  *
- * @param identifier The assumed PhoneNumberIdentifier to be tested.
+ * @param identifier - The assumed PhoneNumberIdentifier to be tested.
  */
@@ -182,3 +182,3 @@ export declare const isPhoneNumberIdentifier: (identifier: CommunicationIdentifier) => identifier is PhoneNumberIdentifier;
  *
- * @param identifier The assumed UnknownIdentifier to be tested.
+ * @param identifier - The assumed UnknownIdentifier to be tested.
  */
@@ -218,4 +218,4 @@ export declare const isUnknownIdentifier: (identifier: CommunicationIdentifier) => identifier is UnknownIdentifier;
  *
- * @param {string} connectionStringOrUrl
- * @param {*} [credentialOrOptions]
+ * @param connectionStringOrUrl
+ * @param [credentialOrOptions]
  */
@@ -227,3 +227,3 @@ export declare const parseClientArguments: (connectionStringOrUrl: string, credentialOrOptions?: any) => UrlWithCredential;
  *
- * @param {string} connectionString The connection string to parse
+ * @param connectionString - The connection string to parse
  * @returns {EndpointCredential} Object to access the endpoint and the credenials
@@ -230,0 +230,0 @@ */

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

144933

decreased by-0.25%

No dependency changes