@aws/pdk/node_modules/sort-keys/index.d.ts

All documentation is located at: https://aws.github.io/aws-pdk

declare namespace sortKeys {
	interface Options {
		/**
		Recursively sort keys, including keys of objects inside arrays.

		@default false
		*/
		readonly deep?: boolean;

		/**
		[Compare function.](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort)
		*/
		readonly compare?: (left: string, right: string) => number;
	}
}

/**
Sort the keys of an object.

@returns A new object with sorted keys.

@example
```
import sortKeys = require('sort-keys');

sortKeys({c: 0, a: 0, b: 0});
//=> {a: 0, b: 0, c: 0}

sortKeys({b: {b: 0, a: 0}, a: 0}, {deep: true});
//=> {a: 0, b: {a: 0, b: 0}}

sortKeys({b: [{b: 0, a: 0}], a: 0}, {deep: true});
//=> {a: 0, b: [{a: 0, b: 0}]}

sortKeys({c: 0, a: 0, b: 0}, {
	compare: (a, b) => -a.localeCompare(b)
});
//=> {c: 0, b: 0, a: 0}

sortKeys([{b: 0, a:2}], {deep: true});
//=> [{a: 2, b: 0}]
```
*/
declare function sortKeys<T extends {[key: string]: any}>(
	object: T,
	options?: sortKeys.Options
): T;

declare function sortKeys<T>(
	object: Array<T>,
	options?: sortKeys.Options
): Array<T>;

export = sortKeys;