summaryrefslogtreecommitdiffstats
path: root/dom/chrome-webidl/MatchGlob.webidl
blob: 3ed07ae0b47434214e7d40dcf35a0267f6711ebd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/**
 * Represents a simple glob pattern matcher. Any occurrence of "*" in the glob
 * pattern matches any literal string of characters in the string being
 * compared. Additionally, if created with `allowQuestion = true`, any
 * occurrence of "?" in the glob matches any single literal character.
 */
[ChromeOnly, Exposed=Window]
interface MatchGlob {
  [Throws]
  constructor(DOMString glob, optional boolean allowQuestion = true);
  
  /**
   * Returns true if the string matches the glob.
   */
  boolean matches(DOMString string);

  /**
   * The glob string this MatchGlob represents.
   */
  [Constant]
  readonly attribute DOMString glob;
};