npm - @ndlib/ndlib-cdk2 - Versions diffs - 1.0.9 → 1.0.11 - Mend

@@ -1,4 +1,6 @@
 /**
+ * @public
+ *
  * DNS record types
  */
 export declare enum HostAddressType {
@@ -11,6 +13,9 @@ export declare enum HostAddressType {
      */
     A = "A"
 }
+/**
+ * @public
+ */
 export interface HostAddress {
     /**
      * The {@link HostAddressType} of the host address.
@@ -30,6 +35,9 @@ export interface HostAddress {
      */
     service?: string;
 }
+/**
+ * @public
+ */
 export interface HostResolverArguments {
     /**
      * The host name to resolve.
@@ -41,28 +49,37 @@ export interface HostResolverArguments {
     service?: string;
 }
 /**
+ * @public
+ *
  * Host Resolver interface for DNS queries
  */
 export interface HostResolver {
     /**
-     * Resolves the address(es) for {@link HostResolverArguments}. Calls to this
-     * function will likely alter the cache (if implemented) so that if there's
-     * multiple addresses, a different set will be returned on the next call.
-     * @param args arguments with host name query addresses for
+     * Resolves the address(es) for {@link HostResolverArguments} and returns a
+     * list of addresses with (most likely) two addresses, one {@link HostAddressType.AAAA}
+     * and one {@link HostAddressType.A}. Calls to this function will likely alter
+     * the cache (if implemented) so that if there's multiple addresses, a different
+     * set will be returned on the next call.
+     * In the case of multi-answer, still only a maximum of two records should be
+     * returned. The resolver implementation is responsible for caching and rotation
+     * of the multiple addresses that get returned.
+     * Implementations don't have to explictly call getaddrinfo(), they can use
+     * high level abstractions provided in their language runtimes/libraries.
+     * @param args - arguments with host name query addresses for
      * @returns promise with a list of {@link HostAddress}
      */
     resolveAddress(args: HostResolverArguments): Promise<HostAddress[]>;
     /**
      * Reports a failure on a {@link HostAddress} so that the cache (if implemented)
      * can accomodate the failure and likely not return the address until it recovers.
-     * @param addr host address to report a failure on
+     * @param addr - host address to report a failure on
      */
     reportFailureOnAddress(addr: HostAddress): void;
     /**
      * Empties the cache (if implemented) for a {@link HostResolverArguments.hostName}.
      * If {@link HostResolverArguments.hostName} is not provided, the cache (if
      * implemented) is emptied for all host names.
-     * @param args optional arguments to empty the cache for
+     * @param args - optional arguments to empty the cache for
      */
     purgeCache(args?: HostResolverArguments): void;
 }

@@ -1,4 +1,7 @@
 import { AuthScheme } from "./auth";
+/**
+ * @public
+ */
 export interface EndpointPartition {
     name: string;
     dnsSuffix: string;
@@ -6,6 +9,9 @@ export interface EndpointPartition {
     supportsFIPS: boolean;
     supportsDualStack: boolean;
 }
+/**
+ * @public
+ */
 export interface EndpointARN {
     partition: string;
     service: string;
@@ -13,10 +19,16 @@ export interface EndpointARN {
     accountId: string;
     resourceId: Array<string>;
 }
+/**
+ * @public
+ */
 export declare enum EndpointURLScheme {
     HTTP = "http",
     HTTPS = "https"
 }
+/**
+ * @public
+ */
 export interface EndpointURL {
     /**
      * The URL scheme such as http or https.
@@ -41,9 +53,15 @@ export interface EndpointURL {
      */
     isIp: boolean;
 }
+/**
+ * @public
+ */
 export declare type EndpointObjectProperty = string | boolean | {
     [key: string]: EndpointObjectProperty;
 } | EndpointObjectProperty[];
+/**
+ * @public
+ */
 export interface EndpointV2 {
     url: URL;
     properties?: {
@@ -51,6 +69,9 @@ export interface EndpointV2 {
     } & Record<string, EndpointObjectProperty>;
     headers?: Record<string, string[]>;
 }
+/**
+ * @public
+ */
 export declare type EndpointParameters = {
     [name: string]: undefined | string | boolean;
 };

@@ -2,6 +2,8 @@ import { HttpRequest } from "./http";
 import { FinalizeHandler, FinalizeHandlerArguments, FinalizeHandlerOutput, HandlerExecutionContext } from "./middleware";
 import { MetadataBearer } from "./response";
 /**
+ * @public
+ *
  * An event stream message. The headers and body properties will always be
  * defined, with empty headers represented as an object with no keys and an
  * empty body represented as a zero-length Uint8Array.
@@ -10,68 +12,112 @@ export interface Message {
     headers: MessageHeaders;
     body: Uint8Array;
 }
+/**
+ * @public
+ */
 export declare type MessageHeaders = Record<string, MessageHeaderValue>;
+/**
+ * @public
+ */
 export interface BooleanHeaderValue {
     type: "boolean";
     value: boolean;
 }
+/**
+ * @public
+ */
 export interface ByteHeaderValue {
     type: "byte";
     value: number;
 }
+/**
+ * @public
+ */
 export interface ShortHeaderValue {
     type: "short";
     value: number;
 }
+/**
+ * @public
+ */
 export interface IntegerHeaderValue {
     type: "integer";
     value: number;
 }
+/**
+ * @public
+ */
 export interface LongHeaderValue {
     type: "long";
     value: Int64;
 }
+/**
+ * @public
+ */
 export interface BinaryHeaderValue {
     type: "binary";
     value: Uint8Array;
 }
+/**
+ * @public
+ */
 export interface StringHeaderValue {
     type: "string";
     value: string;
 }
+/**
+ * @public
+ */
 export interface TimestampHeaderValue {
     type: "timestamp";
     value: Date;
 }
+/**
+ * @public
+ */
 export interface UuidHeaderValue {
     type: "uuid";
     value: string;
 }
+/**
+ * @public
+ */
 export declare type MessageHeaderValue = BooleanHeaderValue | ByteHeaderValue | ShortHeaderValue | IntegerHeaderValue | LongHeaderValue | BinaryHeaderValue | StringHeaderValue | TimestampHeaderValue | UuidHeaderValue;
+/**
+ * @public
+ */
 export interface Int64 {
     readonly bytes: Uint8Array;
     valueOf: () => number;
     toString: () => string;
 }
 /**
+ * @public
+ *
  * Util functions for serializing or deserializing event stream
  */
 export interface EventStreamSerdeContext {
     eventStreamMarshaller: EventStreamMarshaller;
 }
 /**
+ * @public
+ *
  * A function which deserializes binary event stream message into modeled shape.
  */
 export interface EventStreamMarshallerDeserFn<StreamType> {
     <T>(body: StreamType, deserializer: (input: Record<string, Message>) => Promise<T>): AsyncIterable<T>;
 }
 /**
+ * @public
+ *
  * A function that serializes modeled shape into binary stream message.
  */
 export interface EventStreamMarshallerSerFn<StreamType> {
     <T>(input: AsyncIterable<T>, serializer: (event: T) => Message): StreamType;
 }
 /**
+ * @public
+ *
  * An interface which provides functions for serializing and deserializing binary event stream
  * to/from corresponsing modeled shape.
  */
@@ -79,18 +125,33 @@ export interface EventStreamMarshaller<StreamType = any> {
     deserialize: EventStreamMarshallerDeserFn<StreamType>;
     serialize: EventStreamMarshallerSerFn<StreamType>;
 }
+/**
+ * @public
+ */
 export interface EventStreamRequestSigner {
     sign(request: HttpRequest): Promise<HttpRequest>;
 }
+/**
+ * @public
+ */
 export interface EventStreamPayloadHandler {
     handle: <Input extends object, Output extends MetadataBearer>(next: FinalizeHandler<Input, Output>, args: FinalizeHandlerArguments<Input>, context?: HandlerExecutionContext) => Promise<FinalizeHandlerOutput<Output>>;
 }
+/**
+ * @public
+ */
 export interface EventStreamPayloadHandlerProvider {
     (options: any): EventStreamPayloadHandler;
 }
+/**
+ * @public
+ */
 export interface EventStreamSerdeProvider {
     (options: any): EventStreamMarshaller;
 }
+/**
+ * @public
+ */
 export interface EventStreamSignerProvider {
     (options: any): EventStreamRequestSigner;
 }

@@ -1,5 +1,7 @@
 import { AbortSignal } from "./abort";
 /**
+ * @public
+ *
  * A collection of key/value pairs with case-insensitive keys.
  */
 export interface Headers extends Map<string, string> {
@@ -7,19 +9,21 @@ export interface Headers extends Map<string, string> {
      * Returns a new instance of Headers with the specified header set to the
      * provided value. Does not modify the original Headers instance.
      *
-     * @param headerName    The name of the header to add or overwrite
-     * @param headerValue   The value to which the header should be set
+     * @param headerName - The name of the header to add or overwrite
+     * @param headerValue - The value to which the header should be set
      */
     withHeader(headerName: string, headerValue: string): Headers;
     /**
      * Returns a new instance of Headers without the specified header. Does not
      * modify the original Headers instance.
      *
-     * @param headerName    The name of the header to remove
+     * @param headerName - The name of the header to remove
      */
     withoutHeader(headerName: string): Headers;
 }
 /**
+ * @public
+ *
  * A mapping of header names to string values. Multiple values for the same
  * header should be represented as a single string with values separated by
  * `, `.
@@ -28,10 +32,12 @@ export interface Headers extends Map<string, string> {
  * particular implementation. For example, given the following HeaderBag, where
  * keys differ only in case:
  *
+ * ```json
  *    {
  *        'x-amz-date': '2000-01-01T00:00:00Z',
  *        'X-Amz-Date': '2001-01-01T00:00:00Z'
  *    }
+ * ```
  *
  * The SDK may at any point during processing remove one of the object
  * properties in favor of the other. The headers may or may not be combined, and
@@ -39,6 +45,8 @@ export interface Headers extends Map<string, string> {
  */
 export declare type HeaderBag = Record<string, string>;
 /**
+ * @public
+ *
  * Represents an HTTP message with headers and an optional static or streaming
  * body. bode: ArrayBuffer | ArrayBufferView | string | Uint8Array | Readable | ReadableStream;
  */
@@ -47,13 +55,17 @@ export interface HttpMessage {
     body?: any;
 }
 /**
+ * @public
+ *
  * A mapping of query parameter names to strings or arrays of strings, with the
  * second being used when a parameter contains a list of values. Value can be set
  * to null when query is not in key-value pairs shape
  */
 export declare type QueryParameterBag = Record<string, string | Array<string> | null>;
 /**
- * @deprecated use EndpointV2 from @aws-sdk/types.
+ * @public
+ *
+ * @deprecated use {@link EndpointV2} from `@aws-sdk/types`.
  */
 export interface Endpoint {
     protocol: string;
@@ -63,6 +75,8 @@ export interface Endpoint {
     query?: QueryParameterBag;
 }
 /**
+ * @public
+ *
  * Interface an HTTP request class. Contains
  * addressing information in addition to standard message properties.
  */
@@ -70,6 +84,8 @@ export interface HttpRequest extends HttpMessage, Endpoint {
     method: string;
 }
 /**
+ * @public
+ *
  * Represents an HTTP message as received in reply to a request. Contains a
  * numeric status code in addition to standard message properties.
  */
@@ -77,6 +93,8 @@ export interface HttpResponse extends HttpMessage {
     statusCode: number;
 }
 /**
+ * @public
+ *
  * Represents HTTP message whose body has been resolved to a string. This is
  * used in parsing http message.
  */
@@ -84,6 +102,8 @@ export interface ResolvedHttpResponse extends HttpResponse {
     body: string;
 }
 /**
+ * @public
+ *
  * Represents the options that may be passed to an Http Handler.
  */
 export interface HttpHandlerOptions {

@@ -1,3 +1,6 @@
 import { Identity } from "./Identity";
+/**
+ * @public
+ */
 export interface AnonymousIdentity extends Identity {
 }

@@ -1,4 +1,7 @@
 import { Identity, IdentityProvider } from "./Identity";
+/**
+ * @public
+ */
 export interface AwsCredentialIdentity extends Identity {
     /**
      * AWS access key ID
@@ -14,4 +17,7 @@ export interface AwsCredentialIdentity extends Identity {
      */
     readonly sessionToken?: string;
 }
+/**
+ * @public
+ */
 export declare type AwsCredentialIdentityProvider = IdentityProvider<AwsCredentialIdentity>;

@@ -1,9 +1,15 @@
+/**
+ * @public
+ */
 export interface Identity {
     /**
-     * A {Date} when the identity or credential will no longer be accepted.
+     * A `Date` when the identity or credential will no longer be accepted.
      */
     readonly expiration?: Date;
 }
+/**
+ * @public
+ */
 export interface IdentityProvider<IdentityT extends Identity> {
     (identityProperties?: Record<string, any>): Promise<IdentityT>;
 }

@@ -1,4 +1,7 @@
 import { Identity, IdentityProvider } from "./Identity";
+/**
+ * @public
+ */
 export interface LoginIdentity extends Identity {
     /**
      * Identity username
@@ -9,4 +12,7 @@ export interface LoginIdentity extends Identity {
      */
     readonly password: string;
 }
+/**
+ * @public
+ */
 export declare type LoginIdentityProvider = IdentityProvider<LoginIdentity>;

@@ -1,8 +1,14 @@
 import { Identity, IdentityProvider } from "./Identity";
+/**
+ * @public
+ */
 export interface TokenIdentity extends Identity {
     /**
      * The literal token string
      */
     readonly token: string;
 }
+/**
+ * @public
+ */
 export declare type TokenIdentityProvider = IdentityProvider<TokenIdentity>;

@@ -1,13 +1,17 @@
 /**
+ * @public
+ *
  * A list of logger's log level. These levels are sorted in
  * order of increasing severity. Each log level includes itself and all
  * the levels behind itself.
  *
- * @example new Logger({logLevel: 'warn'}) will print all the warn and error
+ * @example `new Logger({logLevel: 'warn'})` will print all the warn and error
  * message.
  */
 export declare type LogLevel = "all" | "trace" | "debug" | "log" | "info" | "warn" | "error" | "off";
 /**
+ * @public
+ *
  * An object consumed by Logger constructor to initiate a logger object.
  */
 export interface LoggerOptions {
@@ -15,6 +19,8 @@ export interface LoggerOptions {
     logLevel?: LogLevel;
 }
 /**
+ * @public
+ *
  * Represents a logger object that is available in HandlerExecutionContext
  * throughout the middleware stack.
  */

@ndlib/ndlib-cdk2 1.0.9 → 1.0.11