Skip to content

Commit

Permalink
feat(rum-react): add typescript typings
Browse files Browse the repository at this point in the history
  • Loading branch information
vivcogit committed Feb 20, 2023
1 parent 081623c commit 712e660
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions packages/rum-react/src/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/**
* MIT License
*
* Copyright (c) 2017-present, Elasticsearch BV
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/

declare module '@elastic/apm-rum-react' {
import type { ComponentType } from 'react'
import type { Route } from 'react-router'
import type { Transaction } from '@elastic/apm-rum'

/**
* ApmRoute only instruments the route if component property is provided,
* in other cases, e.g. using render or children properties, ApmRoute will
* only renders the route without instrumenting it, please instrument
* the individual component using withTransaction in these cases instead.
*/
export const ApmRoute: typeof Route

export const withTransaction: <T>(
name?: string,
type?: string,
callback?: (transaction: Transaction | undefined, props: T) => {}
) => (component: ComponentType<T>) => ComponentType<T>
}

0 comments on commit 712e660

Please sign in to comment.