# hs.appfinder

Easily find `hs.application` and `hs.window` objects

This module is *deprecated*; you can use `hs.window.find()`, `hs.window.get()`, `hs.application.find()`,
`hs.application.get()`, `hs.application:findWindow()` and `hs.application:getWindow()` instead.

---

## API Overview
**Functions** - _API calls offered directly by the extension_
 * [appFromName](#appfromname)
 * [appFromWindowTitle](#appfromwindowtitle)
 * [appFromWindowTitlePattern](#appfromwindowtitlepattern)
 * [windowFromWindowTitle](#windowfromwindowtitle)
 * [windowFromWindowTitlePattern](#windowfromwindowtitlepattern)

---

## API Documentation

#### Functions

### [appFromName](#appfromname)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `hs.appfinder.appFromName(name) -> app or nil`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Finds an application by its name (e.g. "Safari")                                                                     |
| **Parameters**                              | <ul><li>name - A string containing the name of the application to search for</li></ul> |
| **Returns**                                 | <ul><li>An hs.application object if one can be found, otherwise nil</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [extensions/appfinder/appfinder.lua line 12](https://github.com/CommandPost/CommandPost-App/blob/master/extensions/appfinder/appfinder.lua#L12) |

---

### [appFromWindowTitle](#appfromwindowtitle)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `hs.appfinder.appFromWindowTitle(title) -> app or nil`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Finds an application by its window title (e.g. "Activity Monitor (All Processes)")                                                                     |
| **Parameters**                              | <ul><li>title - A string containing a window title of the application to search for</li></ul> |
| **Returns**                                 | <ul><li>An hs.application object if one can be found, otherwise nil</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [extensions/appfinder/appfinder.lua line 23](https://github.com/CommandPost/CommandPost-App/blob/master/extensions/appfinder/appfinder.lua#L23) |

---

### [appFromWindowTitlePattern](#appfromwindowtitlepattern)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `hs.appfinder.appFromWindowTitlePattern(pattern) -> app or nil`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Finds an application by Lua pattern in its window title (e.g."Inbox %(%d+ messages.*)")                                                                     |
| **Parameters**                              | <ul><li>pattern - a Lua pattern describing a window title of the application to search for</li></ul> |
| **Returns**                                 | <ul><li>An hs.application object if one can be found, otherwise nil</li></ul>          |
| **Notes**                                   | <ul><li>For more about Lua patterns, see http://lua-users.org/wiki/PatternsTutorial and http://www.lua.org/manual/5.2/manual.html#6.4.1</li></ul> |
| **Examples**                                | None |
| **Source**                                  | [extensions/appfinder/appfinder.lua line 36](https://github.com/CommandPost/CommandPost-App/blob/master/extensions/appfinder/appfinder.lua#L36) |

---

### [windowFromWindowTitle](#windowfromwindowtitle)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `hs.appfinder.windowFromWindowTitle(title) -> win or nil`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Finds a window by its title (e.g. "Activity Monitor (All Processes)")                                                                     |
| **Parameters**                              | <ul><li>title - A string containing the title of the window to search for</li></ul> |
| **Returns**                                 | <ul><li>An hs.window object if one can be found, otherwise nil</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [extensions/appfinder/appfinder.lua line 52](https://github.com/CommandPost/CommandPost-App/blob/master/extensions/appfinder/appfinder.lua#L52) |

---

### [windowFromWindowTitlePattern](#windowfromwindowtitlepattern)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `hs.appfinder.windowFromWindowTitlePattern(pattern) -> app or nil`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Finds a window by Lua pattern in its title (e.g."Inbox %(%d+ messages.*)")                                                                     |
| **Parameters**                              | <ul><li>pattern - a Lua pattern describing a window title of the window to search for</li></ul> |
| **Returns**                                 | <ul><li>An hs.window object if one can be found, otherwise nil</li></ul>          |
| **Notes**                                   | <ul><li>For more about Lua patterns, see http://lua-users.org/wiki/PatternsTutorial and http://www.lua.org/manual/5.2/manual.html#6.4.1</li></ul> |
| **Examples**                                | None |
| **Source**                                  | [extensions/appfinder/appfinder.lua line 63](https://github.com/CommandPost/CommandPost-App/blob/master/extensions/appfinder/appfinder.lua#L63) |

---

---

<script src="https://giscus.app/client.js"
        data-repo="CommandPost/CommandPost"
        data-repo-id="MDEwOlJlcG9zaXRvcnk3NDY0NTk2NQ=="
        data-category="Website Discussion"
        data-category-id="DIC_kwDOBHMBzc4CXFFA"
        data-mapping="pathname"
        data-strict="0"
        data-reactions-enabled="1"
        data-emit-metadata="0"
        data-input-position="bottom"
        data-theme="dark"
        data-lang="en"
        crossorigin="anonymous"
        async>
</script>