@contember/utilities 1.2.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/development/assert-types/AssertionError.js +9 -0
- package/dist/development/assert-types/AssertionError.js.map +1 -0
- package/dist/development/assert-types/Predicates.js +84 -0
- package/dist/development/assert-types/Predicates.js.map +1 -0
- package/dist/development/assert-types/assert.js +10 -0
- package/dist/development/assert-types/assert.js.map +1 -0
- package/dist/development/class-name/Internal/deduplicateClassName.js +7 -0
- package/dist/development/class-name/Internal/deduplicateClassName.js.map +1 -0
- package/dist/development/class-name/Internal/flatClassNameList.js +15 -0
- package/dist/development/class-name/Internal/flatClassNameList.js.map +1 -0
- package/dist/development/class-name/classNameFor.js +18 -0
- package/dist/development/class-name/classNameFor.js.map +1 -0
- package/dist/development/class-name/listClassName.js +9 -0
- package/dist/development/class-name/listClassName.js.map +1 -0
- package/dist/development/class-name/stateClassName.js +14 -0
- package/dist/development/class-name/stateClassName.js.map +1 -0
- package/dist/development/css-utilities/px.js +7 -0
- package/dist/development/css-utilities/px.js.map +1 -0
- package/dist/development/dom/getMatchingParentElement.js +17 -0
- package/dist/development/dom/getMatchingParentElement.js.map +1 -0
- package/dist/development/dom/getSizeFromResizeObserverEntry.js +24 -0
- package/dist/development/dom/getSizeFromResizeObserverEntry.js.map +1 -0
- package/dist/development/dom/isScrollable.js +22 -0
- package/dist/development/dom/isScrollable.js.map +1 -0
- package/dist/development/dom/parseTransformMatrix.js +29 -0
- package/dist/development/dom/parseTransformMatrix.js.map +1 -0
- package/dist/development/dom/svgSizeProps.js +15 -0
- package/dist/development/dom/svgSizeProps.js.map +1 -0
- package/dist/development/functional/pick.js +15 -0
- package/dist/development/functional/pick.js.map +1 -0
- package/dist/development/functional/setHasOneOf.js +7 -0
- package/dist/development/functional/setHasOneOf.js.map +1 -0
- package/dist/development/index.js +54 -0
- package/dist/development/index.js.map +1 -0
- package/dist/development/string-utilities/capitalize.js +7 -0
- package/dist/development/string-utilities/capitalize.js.map +1 -0
- package/dist/development/string-utilities/trimString.js +8 -0
- package/dist/development/string-utilities/trimString.js.map +1 -0
- package/dist/production/assert-types/AssertionError.js +9 -0
- package/dist/production/assert-types/AssertionError.js.map +1 -0
- package/dist/production/assert-types/Predicates.js +84 -0
- package/dist/production/assert-types/Predicates.js.map +1 -0
- package/dist/production/assert-types/assert.js +10 -0
- package/dist/production/assert-types/assert.js.map +1 -0
- package/dist/production/class-name/Internal/deduplicateClassName.js +7 -0
- package/dist/production/class-name/Internal/deduplicateClassName.js.map +1 -0
- package/dist/production/class-name/Internal/flatClassNameList.js +15 -0
- package/dist/production/class-name/Internal/flatClassNameList.js.map +1 -0
- package/dist/production/class-name/classNameFor.js +18 -0
- package/dist/production/class-name/classNameFor.js.map +1 -0
- package/dist/production/class-name/listClassName.js +9 -0
- package/dist/production/class-name/listClassName.js.map +1 -0
- package/dist/production/class-name/stateClassName.js +14 -0
- package/dist/production/class-name/stateClassName.js.map +1 -0
- package/dist/production/css-utilities/px.js +7 -0
- package/dist/production/css-utilities/px.js.map +1 -0
- package/dist/production/dom/getMatchingParentElement.js +17 -0
- package/dist/production/dom/getMatchingParentElement.js.map +1 -0
- package/dist/production/dom/getSizeFromResizeObserverEntry.js +24 -0
- package/dist/production/dom/getSizeFromResizeObserverEntry.js.map +1 -0
- package/dist/production/dom/isScrollable.js +22 -0
- package/dist/production/dom/isScrollable.js.map +1 -0
- package/dist/production/dom/parseTransformMatrix.js +29 -0
- package/dist/production/dom/parseTransformMatrix.js.map +1 -0
- package/dist/production/dom/svgSizeProps.js +15 -0
- package/dist/production/dom/svgSizeProps.js.map +1 -0
- package/dist/production/functional/pick.js +15 -0
- package/dist/production/functional/pick.js.map +1 -0
- package/dist/production/functional/setHasOneOf.js +7 -0
- package/dist/production/functional/setHasOneOf.js.map +1 -0
- package/dist/production/index.js +54 -0
- package/dist/production/index.js.map +1 -0
- package/dist/production/string-utilities/capitalize.js +7 -0
- package/dist/production/string-utilities/capitalize.js.map +1 -0
- package/dist/production/string-utilities/trimString.js +8 -0
- package/dist/production/string-utilities/trimString.js.map +1 -0
- package/dist/types/assert-types/AssertionError.d.ts +4 -0
- package/dist/types/assert-types/AssertionError.d.ts.map +1 -0
- package/dist/types/assert-types/Predicates.d.ts +21 -0
- package/dist/types/assert-types/Predicates.d.ts.map +1 -0
- package/dist/types/assert-types/assert.d.ts +2 -0
- package/dist/types/assert-types/assert.d.ts.map +1 -0
- package/dist/types/assert-types/index.d.ts +4 -0
- package/dist/types/assert-types/index.d.ts.map +1 -0
- package/dist/types/class-name/Internal/deduplicateClassName.d.ts +2 -0
- package/dist/types/class-name/Internal/deduplicateClassName.d.ts.map +1 -0
- package/dist/types/class-name/Internal/flatClassNameList.d.ts +3 -0
- package/dist/types/class-name/Internal/flatClassNameList.d.ts.map +1 -0
- package/dist/types/class-name/Types.d.ts +5 -0
- package/dist/types/class-name/Types.d.ts.map +1 -0
- package/dist/types/class-name/classNameFor.d.ts +13 -0
- package/dist/types/class-name/classNameFor.d.ts.map +1 -0
- package/dist/types/class-name/index.d.ts +5 -0
- package/dist/types/class-name/index.d.ts.map +1 -0
- package/dist/types/class-name/listClassName.d.ts +8 -0
- package/dist/types/class-name/listClassName.d.ts.map +1 -0
- package/dist/types/class-name/stateClassName.d.ts +13 -0
- package/dist/types/class-name/stateClassName.d.ts.map +1 -0
- package/dist/types/css-utilities/index.d.ts +2 -0
- package/dist/types/css-utilities/index.d.ts.map +1 -0
- package/dist/types/css-utilities/px.d.ts +6 -0
- package/dist/types/css-utilities/px.d.ts.map +1 -0
- package/dist/types/dom/getMatchingParentElement.d.ts +2 -0
- package/dist/types/dom/getMatchingParentElement.d.ts.map +1 -0
- package/dist/types/dom/getSizeFromResizeObserverEntry.d.ts +5 -0
- package/dist/types/dom/getSizeFromResizeObserverEntry.d.ts.map +1 -0
- package/dist/types/dom/index.d.ts +6 -0
- package/dist/types/dom/index.d.ts.map +1 -0
- package/dist/types/dom/isScrollable.d.ts +7 -0
- package/dist/types/dom/isScrollable.d.ts.map +1 -0
- package/dist/types/dom/parseTransformMatrix.d.ts +15 -0
- package/dist/types/dom/parseTransformMatrix.d.ts.map +1 -0
- package/dist/types/dom/svgSizeProps.d.ts +7 -0
- package/dist/types/dom/svgSizeProps.d.ts.map +1 -0
- package/dist/types/functional/index.d.ts +3 -0
- package/dist/types/functional/index.d.ts.map +1 -0
- package/dist/types/functional/pick.d.ts +2 -0
- package/dist/types/functional/pick.d.ts.map +1 -0
- package/dist/types/functional/setHasOneOf.d.ts +2 -0
- package/dist/types/functional/setHasOneOf.d.ts.map +1 -0
- package/dist/types/index.d.ts +8 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/string-utilities/capitalize.d.ts +2 -0
- package/dist/types/string-utilities/capitalize.d.ts.map +1 -0
- package/dist/types/string-utilities/index.d.ts +3 -0
- package/dist/types/string-utilities/index.d.ts.map +1 -0
- package/dist/types/string-utilities/trimString.d.ts +9 -0
- package/dist/types/string-utilities/trimString.d.ts.map +1 -0
- package/dist/types/tsconfig.tsbuildinfo +1 -0
- package/dist/types/typescript-utilities/DeepPartial.d.ts +4 -0
- package/dist/types/typescript-utilities/DeepPartial.d.ts.map +1 -0
- package/dist/types/typescript-utilities/NonNullableRequired.d.ts +4 -0
- package/dist/types/typescript-utilities/NonNullableRequired.d.ts.map +1 -0
- package/dist/types/typescript-utilities/ObjectKeyValue.d.ts +4 -0
- package/dist/types/typescript-utilities/ObjectKeyValue.d.ts.map +1 -0
- package/dist/types/typescript-utilities/PolymorphicRefs.d.ts +37 -0
- package/dist/types/typescript-utilities/PolymorphicRefs.d.ts.map +1 -0
- package/dist/types/typescript-utilities/Try.d.ts +2 -0
- package/dist/types/typescript-utilities/Try.d.ts.map +1 -0
- package/dist/types/typescript-utilities/index.d.ts +6 -0
- package/dist/types/typescript-utilities/index.d.ts.map +1 -0
- package/package.json +43 -0
- package/src/assert-types/AssertionError.ts +5 -0
- package/src/assert-types/Predicates.ts +61 -0
- package/src/assert-types/assert.ts +14 -0
- package/src/assert-types/index.ts +3 -0
- package/src/class-name/Internal/deduplicateClassName.ts +3 -0
- package/src/class-name/Internal/flatClassNameList.ts +13 -0
- package/src/class-name/Types.ts +2 -0
- package/src/class-name/classNameFor.ts +32 -0
- package/src/class-name/index.ts +4 -0
- package/src/class-name/listClassName.ts +12 -0
- package/src/class-name/stateClassName.ts +27 -0
- package/src/css-utilities/index.ts +1 -0
- package/src/css-utilities/px.ts +16 -0
- package/src/dom/getMatchingParentElement.ts +13 -0
- package/src/dom/getSizeFromResizeObserverEntry.ts +26 -0
- package/src/dom/index.ts +5 -0
- package/src/dom/isScrollable.ts +24 -0
- package/src/dom/parseTransformMatrix.ts +35 -0
- package/src/dom/svgSizeProps.ts +23 -0
- package/src/functional/index.ts +2 -0
- package/src/functional/pick.ts +13 -0
- package/src/functional/setHasOneOf.ts +3 -0
- package/src/index.ts +7 -0
- package/src/string-utilities/capitalize.ts +3 -0
- package/src/string-utilities/index.ts +2 -0
- package/src/string-utilities/trimString.ts +12 -0
- package/src/tsconfig.json +6 -0
- package/src/typescript-utilities/DeepPartial.ts +7 -0
- package/src/typescript-utilities/NonNullableRequired.ts +1 -0
- package/src/typescript-utilities/ObjectKeyValue.ts +1 -0
- package/src/typescript-utilities/PolymorphicRefs.ts +58 -0
- package/src/typescript-utilities/Try.ts +4 -0
- package/src/typescript-utilities/index.ts +5 -0
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export function pick<T extends Object, K extends keyof T>(object: T, properties: K[]): Pick<T, K> {
|
|
2
|
+
const next: Partial<Pick<T, K>> = {}
|
|
3
|
+
|
|
4
|
+
for (let key of properties) {
|
|
5
|
+
if (key in object) {
|
|
6
|
+
next[key] = object[key]
|
|
7
|
+
} else {
|
|
8
|
+
throw new Error(`Key "${String(key)}" does not exist in object ${JSON.stringify(object)}`)
|
|
9
|
+
}
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
return next as Pick<T, K>
|
|
13
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Trims the provided string of any characters in the provided set.
|
|
3
|
+
*
|
|
4
|
+
* @param value - The string to trim.
|
|
5
|
+
* @param characters - The characters to remove.
|
|
6
|
+
* @returns The trimmed string.
|
|
7
|
+
*/
|
|
8
|
+
export function trimString(value: string, characters: string) {
|
|
9
|
+
const regExp = new RegExp(`^[${characters}]*|[${characters}]*$`, 'g')
|
|
10
|
+
|
|
11
|
+
return value.replace(regExp, '')
|
|
12
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type NonNullableRequired<T> = { [P in keyof T]-?: NonNullable<T[P]> };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type ObjectKeyValue<T, K extends keyof T> = T extends { [P in K]: T[P] } ? T[K] : never
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
// Source: https://www.benmvp.com/blog/forwarding-refs-polymorphic-react-component-typescript/
|
|
2
|
+
|
|
3
|
+
// Source: https://github.com/emotion-js/emotion/blob/master/packages/styled-base/types/helper.d.ts
|
|
4
|
+
// A more precise version of just React.ComponentPropsWithoutRef on its own
|
|
5
|
+
export type PropsOf<
|
|
6
|
+
C extends keyof JSX.IntrinsicElements | React.JSXElementConstructor<any>
|
|
7
|
+
> = JSX.LibraryManagedAttributes<C, React.ComponentPropsWithoutRef<C>>
|
|
8
|
+
|
|
9
|
+
export type AsProp<C extends React.ElementType> = {
|
|
10
|
+
/**
|
|
11
|
+
* An override of the default HTML tag.
|
|
12
|
+
* Can also be another React component.
|
|
13
|
+
*/
|
|
14
|
+
as?: C
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Allows for extending a set of props (`ExtendedProps`) by an overriding set of props
|
|
19
|
+
* (`OverrideProps`), ensuring that any duplicates are overridden by the overriding
|
|
20
|
+
* set of props.
|
|
21
|
+
*/
|
|
22
|
+
export type ExtendableProps<
|
|
23
|
+
ExtendedProps = {},
|
|
24
|
+
OverrideProps = {}
|
|
25
|
+
> = OverrideProps & Omit<ExtendedProps, keyof OverrideProps>
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Allows for inheriting the props from the specified element type so that
|
|
29
|
+
* props like children, className & style work, as well as element-specific
|
|
30
|
+
* attributes like aria roles. The component (`C`) must be passed in.
|
|
31
|
+
*/
|
|
32
|
+
export type InheritableElementProps<
|
|
33
|
+
C extends React.ElementType,
|
|
34
|
+
Props = {}
|
|
35
|
+
> = ExtendableProps<PropsOf<C>, Props>
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* A more sophisticated version of `InheritableElementProps` where
|
|
39
|
+
* the passed in `as` prop will determine which props can be included
|
|
40
|
+
*/
|
|
41
|
+
export type PolymorphicComponentProps<
|
|
42
|
+
C extends React.ElementType,
|
|
43
|
+
Props = {}
|
|
44
|
+
> = InheritableElementProps<C, Props & AsProp<C>>
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* Utility type to extract the `ref` prop from a polymorphic component
|
|
48
|
+
*/
|
|
49
|
+
export type PolymorphicRef<C extends React.ElementType> = React.ComponentPropsWithRef<C>['ref']
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* A wrapper of `PolymorphicComponentProps` that also includes the `ref`
|
|
53
|
+
* prop for the polymorphic component
|
|
54
|
+
*/
|
|
55
|
+
export type PolymorphicComponentPropsWithRef<
|
|
56
|
+
C extends React.ElementType,
|
|
57
|
+
Props = {}
|
|
58
|
+
> = PolymorphicComponentProps<C, Props> & { ref?: PolymorphicRef<C> }
|